Struct nalgebra::linalg::FullPivLU

source ·
pub struct FullPivLU<T: ComplexField, R: DimMin<C>, C: Dim>{ /* private fields */ }
Expand description

LU decomposition with full row and column pivoting.

Implementations§

source§

impl<T: ComplexField, R: DimMin<C>, C: Dim> FullPivLU<T, R, C>

source

pub fn new(matrix: OMatrix<T, R, C>) -> Self

Computes the LU decomposition with full pivoting of matrix.

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

source

pub fn l(&self) -> OMatrix<T, R, DimMinimum<R, C>>

The lower triangular matrix of this decomposition.

source

pub fn u(&self) -> OMatrix<T, DimMinimum<R, C>, C>

The upper triangular matrix of this decomposition.

source

pub fn p(&self) -> &PermutationSequence<DimMinimum<R, C>>

The row permutations of this decomposition.

source

pub fn q(&self) -> &PermutationSequence<DimMinimum<R, C>>

The column permutations of this decomposition.

source

pub fn unpack( self ) -> (PermutationSequence<DimMinimum<R, C>>, OMatrix<T, R, DimMinimum<R, C>>, OMatrix<T, DimMinimum<R, C>, C>, PermutationSequence<DimMinimum<R, C>>)
where DefaultAllocator: Allocator<T, R, DimMinimum<R, C>> + Allocator<T, DimMinimum<R, C>, C>,

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

source§

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

source

pub fn solve<R2: Dim, C2: Dim, S2>( &self, b: &Matrix<T, R2, C2, S2> ) -> Option<OMatrix<T, R2, C2>>
where 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.

source

pub fn solve_mut<R2: Dim, C2: Dim, S2>( &self, b: &mut Matrix<T, R2, C2, S2> ) -> bool
where 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.

source

pub fn try_inverse(&self) -> Option<OMatrix<T, D, D>>

Computes the inverse of the decomposed matrix.

Returns None if the decomposed matrix is not invertible.

source

pub fn is_invertible(&self) -> bool

Indicates if the decomposed matrix is invertible.

source

pub fn determinant(&self) -> T

Computes the determinant of the decomposed matrix.

Trait Implementations§

source§

impl<T: Clone + ComplexField, R: Clone + DimMin<C>, C: Clone + Dim> Clone for FullPivLU<T, R, C>

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<T: Debug + ComplexField, R: Debug + DimMin<C>, C: Debug + Dim> Debug for FullPivLU<T, R, C>

source§

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

Formats the value using the given formatter. Read more
source§

impl<T: ComplexField, R: DimMin<C>, C: Dim> Copy for FullPivLU<T, R, C>

Auto Trait Implementations§

§

impl<T, R, C> !RefUnwindSafe for FullPivLU<T, R, C>

§

impl<T, R, C> !Send for FullPivLU<T, R, C>

§

impl<T, R, C> !Sync for FullPivLU<T, R, C>

§

impl<T, R, C> !Unpin for FullPivLU<T, R, C>

§

impl<T, R, C> !UnwindSafe for FullPivLU<T, R, C>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V