Struct nalgebra::linalg::QR

source · [−]

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

Expand description

The QR decomposition of a general matrix.

Implementations

source

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>>,

source

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

Computes the QR decomposition using householder reflections.

source

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

Retrieves the upper trapezoidal submatrix R of this decomposition.

source

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

Retrieves the upper trapezoidal submatrix R of this decomposition.

This is usually faster than r but consumes self.

source

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

Computes the orthogonal matrix Q of this decomposition.

source

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>,

Unpacks this decomposition into its two matrix factors.

source

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

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

source

impl<T: ComplexField, D: DimMin<D, Output = D>> QR<T, D, D> where
DefaultAllocator: Allocator<T, D, D> + Allocator<T, 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 self 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 is 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.

Trait Implementations

source

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>>,

source

fn clone(&self) -> QR<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 QR<T, R, C> where
DefaultAllocator: Allocator<T, R, C> + Allocator<T, DimMinimum<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 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,

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

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

pub 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

source

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

source

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

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

source

pub fn is_in_subset(&self) -> bool

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

source

pub fn to_subset_unchecked(&self) -> SS

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

source

pub 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

pub fn to_owned(&self) -> T

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

source

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

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

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

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

source

Struct nalgebra::linalg::QR

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>>,

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

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

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

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

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>,

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

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

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>,

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>,

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

pub fn is_invertible(&self) -> bool

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>>,

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

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

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>>,

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

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,

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,

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

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

pub fn is_in_subset(&self) -> bool

pub fn to_subset_unchecked(&self) -> SS

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

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

type Owned = T

pub fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

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

pub fn vzip(self) -> V

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>>,

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

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

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

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>,

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

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

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>,

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>,

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>>,

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>>,

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,

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

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

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

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

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

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

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

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

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