Struct heron::rapier_plugin::rapier2d::prelude::nalgebra::FullPivLU

pub struct FullPivLU<T, R, C>where
    T: ComplexField,
    R: DimMin<C>,
    C: Dim,
    DefaultAllocator: Allocator<T, R, C> + Allocator<(usize, usize), <R as DimMin<C>>::Output, Const<1>>,{ /* private fields */ }

LU decomposition with full row and column pivoting.

Implementations

impl<T, R, C> FullPivLU<T, R, C>where
    T: ComplexField,
    R: DimMin<C>,
    C: Dim,
    DefaultAllocator: Allocator<T, R, C> + Allocator<(usize, usize), <R as DimMin<C>>::Output, Const<1>>,

pub fn new(
    matrix: Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer>
) -> FullPivLU<T, R, C>

Computes the LU decomposition with full pivoting of matrix.

This effectively computes P, L, U, Q such that P * matrix * Q = LU.

pub fn l(
    &self
) -> Matrix<T, R, <R as DimMin<C>>::Output, <DefaultAllocator as Allocator<T, R, <R as DimMin<C>>::Output>>::Buffer>where
    DefaultAllocator: Allocator<T, R, <R as DimMin<C>>::Output>,

The lower triangular matrix of this decomposition.

pub fn u(
    &self
) -> Matrix<T, <R as DimMin<C>>::Output, C, <DefaultAllocator as Allocator<T, <R as DimMin<C>>::Output, C>>::Buffer>where
    DefaultAllocator: Allocator<T, <R as DimMin<C>>::Output, C>,

The upper triangular matrix of this decomposition.

pub fn p(&self) -> &PermutationSequence<<R as DimMin<C>>::Output>

The row permutations of this decomposition.

pub fn q(&self) -> &PermutationSequence<<R as DimMin<C>>::Output>

The column permutations of this decomposition.

pub fn unpack(
    self
) -> (PermutationSequence<<R as DimMin<C>>::Output>, Matrix<T, R, <R as DimMin<C>>::Output, <DefaultAllocator as Allocator<T, R, <R as DimMin<C>>::Output>>::Buffer>, Matrix<T, <R as DimMin<C>>::Output, C, <DefaultAllocator as Allocator<T, <R as DimMin<C>>::Output, C>>::Buffer>, PermutationSequence<<R as DimMin<C>>::Output>)where
    DefaultAllocator: Allocator<T, R, <R as DimMin<C>>::Output> + Allocator<T, <R as DimMin<C>>::Output, C>,

The two matrices of this decomposition and the row and column permutations: (P, L, U, Q).

impl<T, D> FullPivLU<T, D, D>where
    T: ComplexField,
    D: DimMin<D, Output = D>,
    DefaultAllocator: Allocator<T, D, D> + Allocator<(usize, usize), D, Const<1>>,

pub fn solve<R2, C2, S2>(
    &self,
    b: &Matrix<T, R2, C2, S2>
) -> Option<Matrix<T, R2, C2, <DefaultAllocator as Allocator<T, R2, C2>>::Buffer>>where
    R2: Dim,
    C2: Dim,
    S2: Storage<T, R2, C2>,
    ShapeConstraint: SameNumberOfRows<R2, D>,
    DefaultAllocator: Allocator<T, R2, C2>,

Solves the linear system self * x = b, where x is the unknown to be determined.

Returns None if the decomposed matrix is not invertible.

pub fn solve_mut<R2, C2, S2>(&self, b: &mut Matrix<T, R2, C2, S2>) -> boolwhere
    R2: Dim,
    C2: Dim,
    S2: StorageMut<T, R2, C2>,
    ShapeConstraint: SameNumberOfRows<R2, D>,

Solves the linear system self * x = b, where x is the unknown to be determined.

If the decomposed matrix is not invertible, this returns false and its input b may be overwritten with garbage.

pub fn try_inverse(
    &self
) -> Option<Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>>

Computes the inverse of the decomposed matrix.

Returns None if the decomposed matrix is not invertible.

pub fn is_invertible(&self) -> bool

Indicates if the decomposed matrix is invertible.

pub fn determinant(&self) -> T

Computes the determinant of the decomposed matrix.

Trait Implementations

impl<T, R, C> Clone for FullPivLU<T, R, C>where
    T: Clone + ComplexField,
    R: Clone + DimMin<C>,
    C: Clone + Dim,
    DefaultAllocator: Allocator<T, R, C> + Allocator<(usize, usize), <R as DimMin<C>>::Output, Const<1>>,

fn clone(&self) -> FullPivLU<T, R, C>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T, R, C> Debug for FullPivLU<T, R, C>where
    T: Debug + ComplexField,
    R: Debug + DimMin<C>,
    C: Debug + Dim,
    DefaultAllocator: Allocator<T, R, C> + Allocator<(usize, usize), <R as DimMin<C>>::Output, Const<1>>,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<T, R, C> Copy for FullPivLU<T, R, C>where
    T: ComplexField,
    R: DimMin<C>,
    C: Dim,
    DefaultAllocator: Allocator<T, R, C> + Allocator<(usize, usize), <R as DimMin<C>>::Output, Const<1>>,
    Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer>: Copy,
    PermutationSequence<<R as DimMin<C>>::Output>: Copy,