pub struct QR<T, R, C> where
T: ComplexField,
R: DimMin<C>,
C: Dim,
DefaultAllocator: Allocator<T, R, C>,
DefaultAllocator: Allocator<T, <R as DimMin<C>>::Output, Const<1_usize>>, { /* private fields */ }
Expand description
The QR decomposition of a general matrix.
Implementations
sourceimpl<T, R, C> QR<T, R, C> where
T: ComplexField,
R: DimMin<C>,
C: Dim,
DefaultAllocator: Allocator<T, R, C>,
DefaultAllocator: Allocator<T, R, Const<1_usize>>,
DefaultAllocator: Allocator<T, <R as DimMin<C>>::Output, Const<1_usize>>,
impl<T, R, C> QR<T, R, C> where
T: ComplexField,
R: DimMin<C>,
C: Dim,
DefaultAllocator: Allocator<T, R, C>,
DefaultAllocator: Allocator<T, R, Const<1_usize>>,
DefaultAllocator: Allocator<T, <R as DimMin<C>>::Output, Const<1_usize>>,
sourcepub fn new(
matrix: Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer>
) -> QR<T, R, C>
pub fn new(
matrix: Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer>
) -> QR<T, R, C>
Computes the QR decomposition using householder reflections.
sourcepub fn r(
&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>,
pub fn r(
&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>,
Retrieves the upper trapezoidal submatrix R
of this decomposition.
sourcepub fn unpack_r(
self
) -> Matrix<T, <R as DimMin<C>>::Output, C, <DefaultAllocator as Allocator<T, <R as DimMin<C>>::Output, C>>::Buffer> where
DefaultAllocator: Reallocator<T, R, C, <R as DimMin<C>>::Output, C>,
pub fn unpack_r(
self
) -> Matrix<T, <R as DimMin<C>>::Output, C, <DefaultAllocator as Allocator<T, <R as DimMin<C>>::Output, C>>::Buffer> where
DefaultAllocator: Reallocator<T, 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
.
sourcepub fn q(
&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>,
pub fn q(
&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>,
Computes the orthogonal matrix Q
of this decomposition.
sourcepub fn unpack(
self
) -> (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
<R as DimMin<C>>::Output: DimMin<C>,
DefaultAllocator: Allocator<T, R, <R as DimMin<C>>::Output>,
DefaultAllocator: Reallocator<T, R, C, <R as DimMin<C>>::Output, C>,
<<R as DimMin<C>>::Output as DimMin<C>>::Output == <R as DimMin<C>>::Output,
pub fn unpack(
self
) -> (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
<R as DimMin<C>>::Output: DimMin<C>,
DefaultAllocator: Allocator<T, R, <R as DimMin<C>>::Output>,
DefaultAllocator: Reallocator<T, 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.
sourceimpl<T, D> QR<T, D, D> where
T: ComplexField,
D: DimMin<D, Output = D>,
DefaultAllocator: Allocator<T, D, D>,
DefaultAllocator: Allocator<T, D, Const<1_usize>>,
impl<T, D> QR<T, D, D> where
T: ComplexField,
D: DimMin<D, Output = D>,
DefaultAllocator: Allocator<T, D, D>,
DefaultAllocator: Allocator<T, D, Const<1_usize>>,
sourcepub 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>,
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.
sourcepub fn solve_mut<R2, C2, S2>(&self, b: &mut Matrix<T, R2, C2, S2>) -> bool where
R2: Dim,
C2: Dim,
S2: StorageMut<T, R2, C2>,
ShapeConstraint: SameNumberOfRows<R2, D>,
pub fn solve_mut<R2, C2, S2>(&self, b: &mut Matrix<T, R2, C2, S2>) -> bool where
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
is
overwritten with garbage.
sourcepub fn try_inverse(
&self
) -> Option<Matrix<T, D, D, <DefaultAllocator as Allocator<T, D, D>>::Buffer>>
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 decomposed matrix is not invertible.
sourcepub fn is_invertible(&self) -> bool
pub fn is_invertible(&self) -> bool
Indicates if the decomposed matrix is invertible.
Trait Implementations
sourceimpl<T, R, C> Clone for QR<T, R, C> where
T: Clone + ComplexField,
R: Clone + DimMin<C>,
C: Clone + Dim,
DefaultAllocator: Allocator<T, R, C>,
DefaultAllocator: Allocator<T, <R as DimMin<C>>::Output, Const<1_usize>>,
impl<T, R, C> Clone for QR<T, R, C> where
T: Clone + ComplexField,
R: Clone + DimMin<C>,
C: Clone + Dim,
DefaultAllocator: Allocator<T, R, C>,
DefaultAllocator: Allocator<T, <R as DimMin<C>>::Output, Const<1_usize>>,
sourceimpl<T, R, C> Debug for QR<T, R, C> where
T: Debug + ComplexField,
R: Debug + DimMin<C>,
C: Debug + Dim,
DefaultAllocator: Allocator<T, R, C>,
DefaultAllocator: Allocator<T, <R as DimMin<C>>::Output, Const<1_usize>>,
impl<T, R, C> Debug for QR<T, R, C> where
T: Debug + ComplexField,
R: Debug + DimMin<C>,
C: Debug + Dim,
DefaultAllocator: Allocator<T, R, C>,
DefaultAllocator: Allocator<T, <R as DimMin<C>>::Output, Const<1_usize>>,
impl<T, R, C> Copy for QR<T, R, C> where
T: ComplexField,
R: DimMin<C>,
C: Dim,
DefaultAllocator: Allocator<T, R, C>,
DefaultAllocator: Allocator<T, <R as DimMin<C>>::Output, Const<1_usize>>,
Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer>: Copy,
Matrix<T, <R as DimMin<C>>::Output, Const<1_usize>, <DefaultAllocator as Allocator<T, <R as DimMin<C>>::Output, Const<1_usize>>>::Buffer>: 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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, 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
. Read more
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
pub fn as_any(&self) -> &(dyn Any + 'static)
pub 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. Read more
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
pub 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. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<T> Pointable for T
impl<T> Pointable for T
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
pub fn to_subset(&self) -> Option<SS>
pub fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
pub fn is_in_subset(&self) -> bool
pub fn is_in_subset(&self) -> bool
Checks if self
is actually part of its subset T
(and can be converted to it).
pub fn to_subset_unchecked(&self) -> SS
pub fn to_subset_unchecked(&self) -> SS
Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
pub fn from_subset(element: &SS) -> SP
pub fn from_subset(element: &SS) -> SP
The inclusion map: converts self
to the equivalent element of its superset.
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
pub fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more