pub struct LU<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 */ }
Expand description

LU decomposition with partial (row) pivoting.

Implementations§

source§

impl<T, R, C> LU<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>>,

source

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

Computes the LU decomposition with partial (row) pivoting of matrix.

source

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.

source

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

The lower triangular matrix of this decomposition.

source

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.

source

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

The row permutations of this decomposition.

source

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>)where DefaultAllocator: Allocator<T, R, <R as DimMin<C>>::Output> + Allocator<T, <R as DimMin<C>>::Output, C> + Reallocator<T, R, C, R, <R as DimMin<C>>::Output>,

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

source§

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

source

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 self is not invertible.

source

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.

source

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 matrix is not invertible.

source

pub fn try_inverse_to<S2>(&self, out: &mut Matrix<T, D, D, S2>) -> boolwhere S2: StorageMut<T, D, D>,

Computes the inverse of the decomposed matrix and outputs the result to out.

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

source

pub fn determinant(&self) -> T

Computes the determinant of the decomposed matrix.

source

pub fn is_invertible(&self) -> bool

Indicates if the decomposed matrix is invertible.

Trait Implementations§

source§

impl<T, R, C> Clone for LU<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>>,

source§

fn clone(&self) -> LU<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, R, C> Debug for LU<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>>,

source§

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

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

impl<'de, T, R, C> Deserialize<'de> for LU<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>: Deserialize<'de>, PermutationSequence<<R as DimMin<C>>::Output>: Deserialize<'de>,

source§

fn deserialize<__D>( __deserializer: __D ) -> Result<LU<T, R, C>, <__D as Deserializer<'de>>::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl<T, R, C> Serialize for LU<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>: Serialize, PermutationSequence<<R as DimMin<C>>::Output>: Serialize,

source§

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl<T, R, C> Copy for LU<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,

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
§

impl<T> Downcast for Twhere T: Any,

§

fn into_any(self: Box<T, Global>) -> Box<dyn Any, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T, Global>) -> Rc<dyn Any, Global>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> Finalize for T

§

unsafe fn finalize_raw(data: *mut ())

Safety 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 Twhere 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<T> for T

§

type Output = T

Should always be Self
§

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

§

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

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

fn is_in_subset(&self) -> bool

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

fn to_subset_unchecked(&self) -> SS

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

fn from_subset(element: &SS) -> SP

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

impl<T> ToOwned for Twhere 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 Twhere 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 Twhere 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.