Struct extendr_api::prelude::sparse::linalg::cholesky::supernodal::SupernodalIntranodeBunchKaufmanRef
pub struct SupernodalIntranodeBunchKaufmanRef<'a, I, E>{
symbolic: &'a SymbolicSupernodalCholesky<I>,
values: SliceGroup<'a, E>,
subdiag: SliceGroup<'a, E>,
pub(super) perm: PermRef<'a, I>,
}
Expand description
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>
impl<'a, I, E> SupernodalIntranodeBunchKaufmanRef<'a, I, E>
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>
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>
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 solve_in_place_no_numeric_permute_with_conj(
self,
conj: Conj,
rhs: MatMut<'_, E>,
parallelism: Parallelism<'_>,
stack: PodStack<'_>,
)where
E: ComplexField,
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>
impl<'a, I, E> Clone for SupernodalIntranodeBunchKaufmanRef<'a, I, E>
§fn clone(&self) -> SupernodalIntranodeBunchKaufmanRef<'a, I, E>
fn clone(&self) -> SupernodalIntranodeBunchKaufmanRef<'a, I, E>
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read more§impl<'a, I, E> Debug for SupernodalIntranodeBunchKaufmanRef<'a, I, E>
impl<'a, I, E> Debug for SupernodalIntranodeBunchKaufmanRef<'a, I, E>
impl<'a, I, E> Copy for SupernodalIntranodeBunchKaufmanRef<'a, I, E>
Auto Trait Implementations§
impl<'a, I, E> Freeze for SupernodalIntranodeBunchKaufmanRef<'a, I, E>
impl<'a, I, E> RefUnwindSafe for SupernodalIntranodeBunchKaufmanRef<'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 SupernodalIntranodeBunchKaufmanRef<'a, I, E>
impl<'a, I, E> Sync for SupernodalIntranodeBunchKaufmanRef<'a, I, E>
impl<'a, I, E> Unpin for SupernodalIntranodeBunchKaufmanRef<'a, I, E>
impl<'a, I, E> UnwindSafe for SupernodalIntranodeBunchKaufmanRef<'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
Mutably borrows from an owned value. Read more
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)
🔬This is a nightly-only experimental API. (
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> ⓘ
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 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> ⓘ
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