Struct extendr_api::prelude::sparse::linalg::lu::simplicial::SimplicialLu
pub struct SimplicialLu<I, E>where
E: Entity,{
nrows: usize,
ncols: usize,
l_col_ptr: Vec<I>,
l_row_ind: Vec<I>,
l_val: VecGroup<E>,
u_col_ptr: Vec<I>,
u_row_ind: Vec<I>,
u_val: VecGroup<E>,
}
Expand description
LU factor structure containing the symbolic and numerical representations.
Fields§
§nrows: usize
§ncols: usize
§l_col_ptr: Vec<I>
§l_row_ind: Vec<I>
§l_val: VecGroup<E>
§u_col_ptr: Vec<I>
§u_row_ind: Vec<I>
§u_val: VecGroup<E>
Implementations§
§impl<I, E> SimplicialLu<I, E>
impl<I, E> SimplicialLu<I, E>
pub fn new() -> SimplicialLu<I, E>
pub fn new() -> SimplicialLu<I, E>
Creates a new Simplicial LU of a $0\times 0$ matrix.
pub fn l_factor_unsorted(&self) -> SparseColMatRef<'_, I, E>
pub fn l_factor_unsorted(&self) -> SparseColMatRef<'_, I, E>
Returns the $L$ factor of the LU factorization. The row indices may or may not be sorted.
pub fn u_factor_unsorted(&self) -> SparseColMatRef<'_, I, E>
pub fn u_factor_unsorted(&self) -> SparseColMatRef<'_, I, E>
Returns the $U$ factor of the LU factorization. The row indices may or may not be sorted.
pub fn solve_in_place_with_conj(
&self,
row_perm: PermRef<'_, I>,
col_perm: PermRef<'_, I>,
conj_lhs: Conj,
rhs: MatMut<'_, E>,
parallelism: Parallelism<'_>,
work: MatMut<'_, E>,
)where
E: ComplexField,
pub fn solve_in_place_with_conj(
&self,
row_perm: PermRef<'_, I>,
col_perm: PermRef<'_, I>,
conj_lhs: Conj,
rhs: MatMut<'_, E>,
parallelism: Parallelism<'_>,
work: MatMut<'_, E>,
)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,
row_perm: PermRef<'_, I>,
col_perm: PermRef<'_, I>,
conj_lhs: Conj,
rhs: MatMut<'_, E>,
parallelism: Parallelism<'_>,
work: MatMut<'_, E>,
)where
E: ComplexField,
pub fn solve_transpose_in_place_with_conj(
&self,
row_perm: PermRef<'_, I>,
col_perm: PermRef<'_, I>,
conj_lhs: Conj,
rhs: MatMut<'_, E>,
parallelism: Parallelism<'_>,
work: MatMut<'_, E>,
)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<I, E> Clone for SimplicialLu<I, E>
impl<I, E> Clone for SimplicialLu<I, E>
§fn clone(&self) -> SimplicialLu<I, E>
fn clone(&self) -> SimplicialLu<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<I, E> Debug for SimplicialLu<I, E>
impl<I, E> Debug for SimplicialLu<I, E>
§impl<I, E> Default for SimplicialLu<I, E>
impl<I, E> Default for SimplicialLu<I, E>
§fn default() -> SimplicialLu<I, E>
fn default() -> SimplicialLu<I, E>
Returns the “default value” for a type. Read more
Auto Trait Implementations§
impl<I, E> Freeze for SimplicialLu<I, E>
impl<I, E> RefUnwindSafe for SimplicialLu<I, E>where
<<E as Entity>::Group as ForType>::FaerOf<Vec<<E as Entity>::Unit>>: RefUnwindSafe,
I: RefUnwindSafe,
impl<I, E> Send for SimplicialLu<I, E>where
I: Send,
impl<I, E> Sync for SimplicialLu<I, E>where
I: Sync,
impl<I, E> Unpin for SimplicialLu<I, E>
impl<I, E> UnwindSafe for SimplicialLu<I, E>where
<<E as Entity>::Group as ForType>::FaerOf<Vec<<E as Entity>::Unit>>: UnwindSafe,
I: UnwindSafe,
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