Struct extendr_api::prelude::sparse::solvers::FullPivLu

pub struct FullPivLu<E>
where
    E: Entity,
{
    factors: Mat<E>,
    row_perm: Vec<usize>,
    row_perm_inv: Vec<usize>,
    col_perm: Vec<usize>,
    col_perm_inv: Vec<usize>,
    n_transpositions: usize,
}

LU decomposition with full pivoting.

Fields

factors: Mat<E>

row_perm: Vec<usize>

row_perm_inv: Vec<usize>

col_perm: Vec<usize>

col_perm_inv: Vec<usize>

n_transpositions: usize

Implementations

impl<E> FullPivLu<E>

where E: ComplexField,

pub fn new<ViewE>(matrix: MatRef<'_, ViewE>) -> FullPivLu<E>

where ViewE: Conjugate<Canonical = E>,

Returns the LU decomposition of the input matrix with row and column pivoting.

The factorization is such that $PAQ^\top = LU$, where $L$ is lower triangular, $U$ is unit upper triangular, and $P$ is the permutation arising from row pivoting and $Q$ is the permutation due to column pivoting.

pub fn row_permutation(&self) -> PermRef<'_, usize>

Returns the row permutation due to pivoting.

pub fn col_permutation(&self) -> PermRef<'_, usize>

Returns the column permutation due to pivoting.

pub fn transposition_count(&self) -> usize

Returns the number of transpositions that constitute the two permutations.

pub fn compute_l(&self) -> Mat<E>

Returns the factor $L$ of the LU decomposition.

pub fn compute_u(&self) -> Mat<E>

Returns the factor $U$ of the LU decomposition.

Trait Implementations

impl<E> Debug for FullPivLu<E>

where E: Debug + Entity,

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

Formats the value using the given formatter.

impl<E> SolverCore<E> for FullPivLu<E>

where E: ComplexField,

fn inverse(&self) -> Mat<E>

Computes the inverse of the original matrix using the decomposition.

fn reconstruct(&self) -> Mat<E>

Reconstructs the original matrix using the decomposition.

impl<E> SpSolverCore<E> for FullPivLu<E>

where E: ComplexField,

fn nrows(&self) -> usize

Returns the number of rows of the matrix used to construct this decomposition.

fn ncols(&self) -> usize

Returns the number of columns of the matrix used to construct this decomposition.