Struct rin::math::QR

pub struct QR<N, R, C> where
    C: Dim,
    N: ComplexField,
    R: DimMin<C>,
    DefaultAllocator: Allocator<N, R, C>,
    DefaultAllocator: Allocator<N, <R as DimMin<C>>::Output, U1>,  { /* fields omitted */ }

The QR decomposition of a general matrix.

Implementations

impl<N, R, C> QR<N, R, C> where
    C: Dim,
    N: ComplexField,
    R: DimMin<C>,
    DefaultAllocator: Allocator<N, R, C>,
    DefaultAllocator: Allocator<N, R, U1>,
    DefaultAllocator: Allocator<N, <R as DimMin<C>>::Output, U1>, 

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

Computes the QR decomposition using householder reflections.

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

Retrieves the upper trapezoidal submatrix R of this decomposition.

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

Retrieves the upper trapezoidal submatrix R of this decomposition.

This is usually faster than r but consumes self.

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

Computes the orthogonal matrix Q of this decomposition.

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

Unpacks this decomposition into its two matrix factors.

pub fn q_tr_mul<R2, C2, S2>(&self, rhs: &mut Matrix<N, R2, C2, S2>) where
    C2: Dim,
    R2: Dim,
    S2: StorageMut<N, R2, C2>, 

Multiplies the provided matrix by the transpose of the Q matrix of this decomposition.

impl<N, D> QR<N, D, D> where
    N: ComplexField,
    D: DimMin<D, Output = D>,
    DefaultAllocator: Allocator<N, D, D>,
    DefaultAllocator: Allocator<N, D, U1>, 

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

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

Returns None if self is not invertible.

pub fn solve_mut<R2, C2, S2>(&self, b: &mut Matrix<N, R2, C2, S2>) -> bool where
    C2: Dim,
    R2: Dim,
    S2: StorageMut<N, 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 is overwritten with garbage.

pub fn try_inverse(
    &self
) -> Option<Matrix<N, D, D, <DefaultAllocator as Allocator<N, 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.

Trait Implementations

impl<N, R, C> Clone for QR<N, R, C> where
    C: Clone + Dim,
    N: Clone + ComplexField,
    R: Clone + DimMin<C>,
    DefaultAllocator: Allocator<N, R, C>,
    DefaultAllocator: Allocator<N, <R as DimMin<C>>::Output, U1>, 

pub fn clone(&self) -> QR<N, R, C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N, R, C> Debug for QR<N, R, C> where
    C: Debug + Dim,
    N: Debug + ComplexField,
    R: Debug + DimMin<C>,
    DefaultAllocator: Allocator<N, R, C>,
    DefaultAllocator: Allocator<N, <R as DimMin<C>>::Output, U1>, 

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

Formats the value using the given formatter.

impl<'de, N, R, C> Deserialize<'de> for QR<N, R, C> where
    C: Dim,
    N: ComplexField,
    R: DimMin<C>,
    DefaultAllocator: Allocator<N, R, C>,
    DefaultAllocator: Allocator<N, <R as DimMin<C>>::Output, U1>,
    DefaultAllocator: Allocator<N, R, C>,
    DefaultAllocator: Allocator<N, <R as DimMin<C>>::Output, U1>,
    Matrix<N, R, C, <DefaultAllocator as Allocator<N, R, C>>::Buffer>: Deserialize<'de>,
    Matrix<N, <R as DimMin<C>>::Output, U1, <DefaultAllocator as Allocator<N, <R as DimMin<C>>::Output, U1>>::Buffer>: Deserialize<'de>, 

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

Deserialize this value from the given Serde deserializer.

impl<N, R, C> Serialize for QR<N, R, C> where
    C: Dim,
    N: ComplexField,
    R: DimMin<C>,
    DefaultAllocator: Allocator<N, R, C>,
    DefaultAllocator: Allocator<N, <R as DimMin<C>>::Output, U1>,
    DefaultAllocator: Allocator<N, R, C>,
    DefaultAllocator: Allocator<N, <R as DimMin<C>>::Output, U1>,
    Matrix<N, R, C, <DefaultAllocator as Allocator<N, R, C>>::Buffer>: Serialize,
    Matrix<N, <R as DimMin<C>>::Output, U1, <DefaultAllocator as Allocator<N, <R as DimMin<C>>::Output, U1>>::Buffer>: Serialize, 

pub 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.

impl<N, R, C> Copy for QR<N, R, C> where
    C: Dim,
    N: ComplexField,
    R: DimMin<C>,
    DefaultAllocator: Allocator<N, R, C>,
    DefaultAllocator: Allocator<N, <R as DimMin<C>>::Output, U1>,
    Matrix<N, R, C, <DefaultAllocator as Allocator<N, R, C>>::Buffer>: Copy,
    Matrix<N, <R as DimMin<C>>::Output, U1, <DefaultAllocator as Allocator<N, <R as DimMin<C>>::Output, U1>>::Buffer>: Copy,