Struct extendr_api::prelude::solvers::ColPivQr
pub struct ColPivQr<E>where
E: Entity,{
factors: Mat<E>,
householder: Mat<E>,
col_perm: Vec<usize>,
col_perm_inv: Vec<usize>,
}
Expand description
QR decomposition with column pivoting.
Fields§
§factors: Mat<E>
§householder: Mat<E>
§col_perm: Vec<usize>
§col_perm_inv: Vec<usize>
Implementations§
§impl<E> ColPivQr<E>where
E: ComplexField,
impl<E> ColPivQr<E>where
E: ComplexField,
pub fn new<ViewE>(matrix: MatRef<'_, ViewE>) -> ColPivQr<E>where
ViewE: Conjugate<Canonical = E>,
pub fn new<ViewE>(matrix: MatRef<'_, ViewE>) -> ColPivQr<E>where
ViewE: Conjugate<Canonical = E>,
Returns the QR decomposition of the input matrix with column pivoting.
The factorization is such that $AP^\top = QR$, where $R$ is upper trapezoidal, $Q$ is unitary, and $P$ is a permutation matrix.
pub fn col_permutation(&self) -> PermRef<'_, usize>
pub fn col_permutation(&self) -> PermRef<'_, usize>
Returns the column permutation matrix $P$ of the QR decomposition.
pub fn compute_thin_r(&self) -> Mat<E>
pub fn compute_thin_r(&self) -> Mat<E>
Returns the top $r$ rows of the factor $R$ of the QR decomposition, where $r = \min(\text{nrows}(A), \text{ncols}(A))$.
pub fn compute_thin_q(&self) -> Mat<E>
pub fn compute_thin_q(&self) -> Mat<E>
Returns the leftmost $r$ columns of the factor $R$ of the QR decomposition, where $r = \min(\text{nrows}(A), \text{ncols}(A))$.
Trait Implementations§
§impl<E> SolverCore<E> for ColPivQr<E>where
E: ComplexField,
impl<E> SolverCore<E> for ColPivQr<E>where
E: ComplexField,
§impl<E> SpSolverCore<E> for ColPivQr<E>where
E: ComplexField,
impl<E> SpSolverCore<E> for ColPivQr<E>where
E: ComplexField,
impl<E> SolverLstsqCore<E> for ColPivQr<E>where
E: ComplexField,
impl<E> SpSolverLstsqCore<E> for ColPivQr<E>where
E: ComplexField,
Auto Trait Implementations§
impl<E> Freeze for ColPivQr<E>
impl<E> RefUnwindSafe for ColPivQr<E>where
<<E as Entity>::Group as ForCopyType>::FaerOfCopy<NonNull<<E as Entity>::Unit>>: RefUnwindSafe,
E: RefUnwindSafe,
impl<E> Send for ColPivQr<E>
impl<E> Sync for ColPivQr<E>
impl<E> Unpin for ColPivQr<E>
impl<E> UnwindSafe for ColPivQr<E>where
<<E as Entity>::Group as ForCopyType>::FaerOfCopy<NonNull<<E as Entity>::Unit>>: UnwindSafe,
E: UnwindSafe,
Blanket Implementations§
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
Mutably borrows from an owned value. Read more
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> ⓘ
Converts
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> ⓘ
Converts
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<T> Pointable for T
impl<T> Pointable for T
§impl<E, Dec> SpSolver<E> for Dec
impl<E, Dec> SpSolver<E> for Dec
§fn solve_in_place(&self, rhs: impl ColBatchMut<E>)
fn solve_in_place(&self, rhs: impl ColBatchMut<E>)
Solves the equation
self * X = rhs
, and stores the result in rhs
.§fn solve_conj_in_place(&self, rhs: impl ColBatchMut<E>)
fn solve_conj_in_place(&self, rhs: impl ColBatchMut<E>)
Solves the equation
conjugate(self) * X = rhs
, and stores the result in rhs
.§fn solve_transpose_in_place(&self, rhs: impl ColBatchMut<E>)
fn solve_transpose_in_place(&self, rhs: impl ColBatchMut<E>)
Solves the equation
transpose(self) * X = rhs
, and stores the result in rhs
.§fn solve_conj_transpose_in_place(&self, rhs: impl ColBatchMut<E>)
fn solve_conj_transpose_in_place(&self, rhs: impl ColBatchMut<E>)
Solves the equation
adjoint(self) * X = rhs
, and stores the result in rhs
.§fn solve<ViewE, B>(&self, rhs: B) -> <B as ColBatch<ViewE>>::Owned
fn solve<ViewE, B>(&self, rhs: B) -> <B as ColBatch<ViewE>>::Owned
Solves the equation
self * X = rhs
, and returns the result.§fn solve_conj<ViewE, B>(&self, rhs: B) -> <B as ColBatch<ViewE>>::Owned
fn solve_conj<ViewE, B>(&self, rhs: B) -> <B as ColBatch<ViewE>>::Owned
Solves the equation
conjugate(self) * X = rhs
, and returns the result.§fn solve_transpose<ViewE, B>(&self, rhs: B) -> <B as ColBatch<ViewE>>::Owned
fn solve_transpose<ViewE, B>(&self, rhs: B) -> <B as ColBatch<ViewE>>::Owned
Solves the equation
transpose(self) * X = rhs
, and returns the result.§impl<E, Dec> SpSolverLstsq<E> for Dec
impl<E, Dec> SpSolverLstsq<E> for Dec
§fn solve_lstsq_in_place(&self, rhs: impl ColBatchMut<E>)
fn solve_lstsq_in_place(&self, rhs: impl ColBatchMut<E>)
Solves the equation
self * X = rhs
, in the sense of least squares, and stores the
result in the top rows of rhs
.§fn solve_lstsq_conj_in_place(&self, rhs: impl ColBatchMut<E>)
fn solve_lstsq_conj_in_place(&self, rhs: impl ColBatchMut<E>)
Solves the equation
conjugate(self) * X = rhs
, in the sense of least squares, and
stores the result in the top rows of rhs
.§fn solve_lstsq<ViewE, B>(&self, rhs: B) -> <B as ColBatch<ViewE>>::Owned
fn solve_lstsq<ViewE, B>(&self, rhs: B) -> <B as ColBatch<ViewE>>::Owned
Solves the equation
self * X = rhs
, and returns the result.