Struct extendr_api::prelude::sparse::linalg::cholesky::supernodal::SupernodalLltRef
pub struct SupernodalLltRef<'a, I, E>{
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>
impl<'a, I, E> SupernodalLltRef<'a, I, E>
pub fn new(
symbolic: &'a SymbolicSupernodalCholesky<I>,
values: <<E as Entity>::Group as ForType>::FaerOf<&'a [<E as Entity>::Unit]>,
) -> SupernodalLltRef<'a, I, E>
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>
pub fn symbolic(self) -> &'a SymbolicSupernodalCholesky<I>
Returns the symbolic part of the Cholesky factor.
pub fn values(self) -> SliceGroup<'a, E>
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>
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,
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,
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,
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>
impl<'a, I, E> Clone for SupernodalLltRef<'a, I, E>
§fn clone(&self) -> SupernodalLltRef<'a, I, E>
fn clone(&self) -> SupernodalLltRef<'a, I, E>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more§impl<'a, I, E> Debug for SupernodalLltRef<'a, I, E>
impl<'a, I, E> Debug for SupernodalLltRef<'a, I, E>
impl<'a, I, E> Copy for SupernodalLltRef<'a, I, E>
Auto Trait Implementations§
impl<'a, I, E> Freeze for SupernodalLltRef<'a, I, E>
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>
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> 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
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)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> ⓘ
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> ⓘ
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