Struct extendr_api::prelude::sparse::linalg::lu::LuRef

pub struct LuRef<'a, I, E>
where
    I: Index,
    E: Entity,
{
    symbolic: &'a SymbolicLu<I>,
    numeric: &'a NumericLu<I, E>,
}

Sparse LU factorization wrapper.

Fields

symbolic: &'a SymbolicLu<I>

numeric: &'a NumericLu<I, E>

Implementations

impl<'a, I, E> LuRef<'a, I, E>

where I: Index, E: Entity,

pub unsafe fn new_unchecked( symbolic: &'a SymbolicLu<I>, numeric: &'a NumericLu<I, E>, ) -> LuRef<'a, I, E>

Creates LU factors from their components.

Safety

The numeric part must be the output of SymbolicLu::factorize_numeric_lu, called with a matrix having the same symbolic structure as the one used to create symbolic.

pub fn symbolic(self) -> &'a SymbolicLu<I>

Returns the symbolic structure of the LU factorization.

pub fn row_perm(self) -> PermRef<'a, I>

Returns the row pivoting permutation.

pub fn col_perm(self) -> PermRef<'a, I>

Returns the fill reducing column permutation.

pub fn solve_in_place_with_conj( self, conj: Conj, rhs: MatMut<'_, E>, parallelism: Parallelism<'_>, stack: PodStack<'_>, )

where E: ComplexField,

Solves the equation $\text{Op}(A) x = \text{rhs}$ and stores the result in rhs, where $\text{Op}$ is either the identity or the conjugate, depending on the value of conj.

Panics

• Panics if self.nrows() != self.ncols().
• Panics if rhs.nrows() != self.nrows().

pub fn solve_transpose_in_place_with_conj( self, conj: Conj, rhs: MatMut<'_, E>, parallelism: Parallelism<'_>, stack: PodStack<'_>, )

where E: ComplexField,

Solves the equation $\text{Op}(A^\top) x = \text{rhs}$ and stores the result in rhs, where $\text{Op}$ is either the identity or the conjugate, depending on the value of conj.

Panics

• Panics if self.nrows() != self.ncols().
• Panics if rhs.nrows() != self.nrows().

Trait Implementations

impl<'a, I, E> Clone for LuRef<'a, I, E>

where I: Index, E: Entity,

fn clone(&self) -> LuRef<'a, I, E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, I, E> Debug for LuRef<'a, I, E>

where I: Debug + Index, E: Debug + Entity,

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

Formats the value using the given formatter.

impl<'a, I, E> Copy for LuRef<'a, I, E>

where I: Index, E: Entity,