Struct extendr_api::prelude::sparse::linalg::cholesky::supernodal::SupernodalIntranodeBunchKaufmanRef

pub struct SupernodalIntranodeBunchKaufmanRef<'a, I, E>
where
    I: Index,
    E: Entity,
{
    symbolic: &'a SymbolicSupernodalCholesky<I>,
    values: SliceGroup<'a, E>,
    subdiag: SliceGroup<'a, E>,
    pub(super) perm: PermRef<'a, I>,
}

Cholesky Bunch-Kaufman factors containing both the symbolic and numeric representations.

Fields

symbolic: &'a SymbolicSupernodalCholesky<I>

values: SliceGroup<'a, E>

subdiag: SliceGroup<'a, E>

perm: PermRef<'a, I>

Implementations

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

where I: Index, E: Entity,

pub fn new( symbolic: &'a SymbolicSupernodalCholesky<I>, values: <<E as Entity>::Group as ForType>::FaerOf<&'a [<E as Entity>::Unit]>, subdiag: <<E as Entity>::Group as ForType>::FaerOf<&'a [<E as Entity>::Unit]>, perm: PermRef<'a, I>, ) -> SupernodalIntranodeBunchKaufmanRef<'a, I, E>

Creates a new Cholesky intranodal Bunch-Kaufman factor from the symbolic part and numerical values, as well as the pivoting permutation.

Panics

• Panics if values.len() != symbolic.len_values().
• Panics if subdiag.len() != symbolic.nrows().
• Panics if perm.len() != symbolic.nrows().

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

Returns the symbolic part of the Cholesky factor.

pub fn values(self) -> SliceGroup<'a, E>

Returns the numerical values of the L factor.

pub fn supernode(self, s: usize) -> SupernodeRef<'a, I, E>

Returns the s’th supernode.

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

where E: ComplexField,

Solves the system $\text{Op}(L B L^H) x = \text{rhs}$, where $\text{Op}$ is either the identity or the conjugate depending on the value of conj.

Note

Note that this function doesn’t apply the pivoting permutation. Users are expected to apply it manually to rhs before and after calling this function.

Panics

Panics if rhs.nrows() != self.symbolic().nrows().

Trait Implementations

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

where I: Index, E: Entity,

fn clone(&self) -> SupernodalIntranodeBunchKaufmanRef<'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 SupernodalIntranodeBunchKaufmanRef<'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 SupernodalIntranodeBunchKaufmanRef<'a, I, E>

where I: Index, E: Entity,