extendr_api::prelude::sparse::linalg::cholesky::supernodal

Struct SupernodalLltRef

pub struct SupernodalLltRef<'a, I, E>
where I: Index, E: Entity,
{ symbolic: &'a SymbolicSupernodalCholesky<I>, values: SliceGroup<'a, E>, }
Expand description

Cholesky LLT factor containing both its symbolic and numeric representations.

Fields§

§symbolic: &'a SymbolicSupernodalCholesky<I>§values: SliceGroup<'a, E>

Implementations§

§

impl<'a, I, E> SupernodalLltRef<'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]>, ) -> SupernodalLltRef<'a, I, E>

Creates a new Cholesky LLT factor from the symbolic part and numerical values.

§Panics
  • Panics if values.len() != symbolic.len_values().

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 l_solve_with_conj( &self, conj: Conj, rhs: MatMut<'_, E>, parallelism: Parallelism<'_>, stack: PodStack<'_>, )
where E: ComplexField,

Solves the equation $\text{Op}(L) 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 rhs.nrows() != self.symbolic().nrows().

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

Solves the equation $\text{Op}(L^\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 rhs.nrows() != self.symbolic().nrows().

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 rhs.nrows() != self.symbolic().nrows().

Trait Implementations§

§

impl<'a, I, E> Clone for SupernodalLltRef<'a, I, E>
where I: Index, E: Entity,

§

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

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
§

impl<'a, I, E> Debug for SupernodalLltRef<'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. Read more
§

impl<'a, I, E> Copy for SupernodalLltRef<'a, I, E>
where I: Index, E: Entity,

Auto Trait Implementations§

§

impl<'a, I, E> Freeze for SupernodalLltRef<'a, I, E>
where <<E as Entity>::Group as ForCopyType>::FaerOfCopy<*const [<E as Entity>::Unit]>: Freeze,

§

impl<'a, I, E> RefUnwindSafe for SupernodalLltRef<'a, I, E>
where <<E as Entity>::Group as ForCopyType>::FaerOfCopy<*const [<E as Entity>::Unit]>: RefUnwindSafe, I: RefUnwindSafe,

§

impl<'a, I, E> Send for SupernodalLltRef<'a, I, E>

§

impl<'a, I, E> Sync for SupernodalLltRef<'a, I, E>

§

impl<'a, I, E> Unpin for SupernodalLltRef<'a, I, E>
where <<E as Entity>::Group as ForCopyType>::FaerOfCopy<*const [<E as Entity>::Unit]>: Unpin,

§

impl<'a, I, E> UnwindSafe for SupernodalLltRef<'a, I, E>
where <<E as Entity>::Group as ForCopyType>::FaerOfCopy<*const [<E as Entity>::Unit]>: UnwindSafe, I: RefUnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.