pub struct ColPivQR<T, R, C>where
T: ComplexField,
R: DimMin<C>,
C: Dim,
DefaultAllocator: Allocator<T, R, C> + Allocator<T, <R as DimMin<C>>::Output> + Allocator<(usize, usize), <R as DimMin<C>>::Output>,{
col_piv_qr: Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer>,
p: PermutationSequence<<R as DimMin<C>>::Output>,
diag: Matrix<T, <R as DimMin<C>>::Output, Const<1>, <DefaultAllocator as Allocator<T, <R as DimMin<C>>::Output>>::Buffer>,
}
Expand description
The QR decomposition (with column pivoting) of a general matrix.
Fields§
§col_piv_qr: Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer>
§p: PermutationSequence<<R as DimMin<C>>::Output>
§diag: Matrix<T, <R as DimMin<C>>::Output, Const<1>, <DefaultAllocator as Allocator<T, <R as DimMin<C>>::Output>>::Buffer>
Implementations§
source§impl<T, R, C> ColPivQR<T, R, C>
impl<T, R, C> ColPivQR<T, R, C>
sourcepub fn new(
matrix: Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer>,
) -> ColPivQR<T, R, C>
pub fn new( matrix: Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer>, ) -> ColPivQR<T, R, C>
Computes the ColPivQR
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>
pub fn r( &self, ) -> Matrix<T, <R as DimMin<C>>::Output, C, <DefaultAllocator as Allocator<T, <R as DimMin<C>>::Output, C>>::Buffer>
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>
pub fn unpack_r( self, ) -> Matrix<T, <R as DimMin<C>>::Output, C, <DefaultAllocator as Allocator<T, <R as DimMin<C>>::Output, C>>::Buffer>
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>
pub fn q( &self, ) -> Matrix<T, R, <R as DimMin<C>>::Output, <DefaultAllocator as Allocator<T, R, <R as DimMin<C>>::Output>>::Buffer>
Computes the orthogonal matrix Q
of this decomposition.
sourcepub fn p(&self) -> &PermutationSequence<<R as DimMin<C>>::Output>
pub fn p(&self) -> &PermutationSequence<<R as DimMin<C>>::Output>
Retrieves the column permutation 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>, PermutationSequence<<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>, PermutationSequence<<R as DimMin<C>>::Output>)
Unpacks this decomposition into its two matrix factors.
source§impl<T, D> ColPivQR<T, D, D>where
T: ComplexField,
D: DimMin<D, Output = D>,
DefaultAllocator: Allocator<T, D, D> + Allocator<T, D> + Allocator<(usize, usize), <D as DimMin<D>>::Output>,
impl<T, D> ColPivQR<T, D, D>where
T: ComplexField,
D: DimMin<D, Output = D>,
DefaultAllocator: Allocator<T, D, D> + Allocator<T, D> + Allocator<(usize, usize), <D as DimMin<D>>::Output>,
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: StorageMut<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: StorageMut<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
pub fn solve_mut<R2, C2, S2>(&self, b: &mut Matrix<T, R2, C2, S2>) -> bool
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.
sourcepub fn determinant(&self) -> T
pub fn determinant(&self) -> T
Computes the determinant of the decomposed matrix.
Trait Implementations§
impl<T, R, C> Copy for ColPivQR<T, R, C>where
T: ComplexField,
R: DimMin<C>,
C: Dim,
DefaultAllocator: Allocator<T, R, C> + Allocator<T, <R as DimMin<C>>::Output> + Allocator<(usize, usize), <R as DimMin<C>>::Output>,
Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer>: Copy,
PermutationSequence<<R as DimMin<C>>::Output>: Copy,
Matrix<T, <R as DimMin<C>>::Output, Const<1>, <DefaultAllocator as Allocator<T, <R as DimMin<C>>::Output>>::Buffer>: Copy,
Auto Trait Implementations§
impl<T, R, C> !Freeze for ColPivQR<T, R, C>
impl<T, R, C> !RefUnwindSafe for ColPivQR<T, R, C>
impl<T, R, C> !Send for ColPivQR<T, R, C>
impl<T, R, C> !Sync for ColPivQR<T, R, C>
impl<T, R, C> !Unpin for ColPivQR<T, R, C>
impl<T, R, C> !UnwindSafe for ColPivQR<T, R, C>
Blanket Implementations§
§impl<T, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
§fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
T
[ShaderType
] for self
. When used in [AsBindGroup
]
derives, it is safe to assume that all images in self
exist.§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Copy,
impl<T> CloneToUninit for Twhere
T: Copy,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§impl<T> Conv for T
impl<T> Conv for T
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
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)
fn as_any(&self) -> &(dyn Any + 'static)
&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)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<S> FromSample<S> for S
impl<S> FromSample<S> for S
fn from_sample_(s: S) -> S
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<F, T> IntoSample<T> for Fwhere
T: FromSample<F>,
impl<F, T> IntoSample<T> for Fwhere
T: FromSample<F>,
fn into_sample(self) -> T
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self
from the equivalent element of its
superset. Read more§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self
is actually part of its subset T
(and can be converted to it).§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset
but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self
to the equivalent element of its superset.§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.