Struct nalgebra::linalg::QR[−][src]

pub struct QR<T: ComplexField, R: DimMin<C>, C: Dim> where
    DefaultAllocator: Allocator<T, R, C> + Allocator<T, DimMinimum<R, C>>,  { /* fields omitted */ }
Expand description

The QR decomposition of a general matrix.

Implementations

impl<T: ComplexField, R: DimMin<C>, C: Dim> QR<T, R, C> where
    DefaultAllocator: Allocator<T, R, C> + Allocator<T, R> + Allocator<T, DimMinimum<R, C>>, [src]

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

Computes the QR decomposition using householder reflections.

pub fn r(&self) -> OMatrix<T, DimMinimum<R, C>, C> where
    DefaultAllocator: Allocator<T, DimMinimum<R, C>, C>, [src]

Retrieves the upper trapezoidal submatrix R of this decomposition.

pub fn unpack_r(self) -> OMatrix<T, DimMinimum<R, C>, C> where
    DefaultAllocator: Reallocator<T, R, C, DimMinimum<R, C>, C>, [src]

Retrieves the upper trapezoidal submatrix R of this decomposition.

This is usually faster than r but consumes self.

pub fn q(&self) -> OMatrix<T, R, DimMinimum<R, C>> where
    DefaultAllocator: Allocator<T, R, DimMinimum<R, C>>, [src]

Computes the orthogonal matrix Q of this decomposition.

pub fn unpack(
    self
) -> (OMatrix<T, R, DimMinimum<R, C>>, OMatrix<T, DimMinimum<R, C>, C>) where
    DimMinimum<R, C>: DimMin<C, Output = DimMinimum<R, C>>,
    DefaultAllocator: Allocator<T, R, DimMinimum<R, C>> + Reallocator<T, R, C, DimMinimum<R, C>, C>, [src]

Unpacks this decomposition into its two matrix factors.

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

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

impl<T: ComplexField, D: DimMin<D, Output = D>> QR<T, D, D> where
    DefaultAllocator: Allocator<T, D, D> + Allocator<T, D>, [src]

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>, [src]

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: Dim, C2: Dim, S2>(
    &self,
    b: &mut Matrix<T, R2, C2, S2>
) -> bool where
    S2: StorageMut<T, R2, C2>,
    ShapeConstraint: SameNumberOfRows<R2, D>, [src]

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<OMatrix<T, D, D>>[src]

Computes the inverse of the decomposed matrix.

Returns None if the decomposed matrix is not invertible.

pub fn is_invertible(&self) -> bool[src]

Indicates if the decomposed matrix is invertible.

Trait Implementations

impl<T: Clone + ComplexField, R: Clone + DimMin<C>, C: Clone + Dim> Clone for QR<T, R, C> where
    DefaultAllocator: Allocator<T, R, C> + Allocator<T, DimMinimum<R, C>>, [src]

fn clone(&self) -> QR<T, R, C>[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl<T: Debug + ComplexField, R: Debug + DimMin<C>, C: Debug + Dim> Debug for QR<T, R, C> where
    DefaultAllocator: Allocator<T, R, C> + Allocator<T, DimMinimum<R, C>>, [src]

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

Formats the value using the given formatter. Read more

impl<T: ComplexField, R: DimMin<C>, C: Dim> Copy for QR<T, R, C> where
    DefaultAllocator: Allocator<T, R, C> + Allocator<T, DimMinimum<R, C>>,
    OMatrix<T, R, C>: Copy,
    OVector<T, DimMinimum<R, C>>: Copy, [src]

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

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

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> Same<T> for T[src]

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP where
    SS: SubsetOf<SP>, [src]

pub fn to_subset(&self) -> Option<SS>[src]

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

pub fn is_in_subset(&self) -> bool[src]

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

pub fn to_subset_unchecked(&self) -> SS[src]

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

pub fn from_subset(element: &SS) -> SP[src]

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

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

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

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

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

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

pub fn vzip(self) -> V