IntranodeBunchKaufmanRef

faer_sparse::cholesky

Struct IntranodeBunchKaufmanRef 

Source 
pub struct IntranodeBunchKaufmanRef<'a, I: Index, E: Entity> { /* private fields */ }
Expand description

Sparse intranodal Bunch-Kaufman factorization wrapper.

Implementations§

Source§

impl<'a, I: Index, E: Entity> IntranodeBunchKaufmanRef<'a, I, E>

Source

pub fn new( symbolic: &'a SymbolicCholesky<I>, values: GroupFor<E, &'a [E::Unit]>, subdiag: GroupFor<E, &'a [E::Unit]>, perm: PermutationRef<'a, I, E>, ) -> Self

Source

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

Source

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

Methods from Deref<Target = SymbolicCholesky<I>>§

Source

pub fn nrows(&self) -> usize

Returns the number of rows of the matrix.

Source

pub fn ncols(&self) -> usize

Returns the number of columns of the matrix.

Source

pub fn raw(&self) -> &SymbolicCholeskyRaw<I>

Returns the inner type of the factorization, either simplicial or symbolic.

Source

pub fn perm(&self) -> PermutationRef<'_, I, Symbolic>

Returns the permutation that was computed during symbolic analysis.

Source

pub fn len_values(&self) -> usize

Returns the length of the slice needed to store the numerical values of the Cholesky decomposition.

Source

pub fn factorize_numeric_llt_req<E: Entity>( &self, parallelism: Parallelism, ) -> Result<StackReq, SizeOverflow>

Computes the required workspace size and alignment for a numerical LLT factorization.

Source

pub fn factorize_numeric_ldlt_req<E: Entity>( &self, with_regularization_signs: bool, parallelism: Parallelism, ) -> Result<StackReq, SizeOverflow>

Computes the required workspace size and alignment for a numerical LDLT factorization.

Source

pub fn factorize_numeric_intranode_bunch_kaufman_req<E: Entity>( &self, with_regularization_signs: bool, parallelism: Parallelism, ) -> Result<StackReq, SizeOverflow>

Computes the required workspace size and alignment for a numerical intranodal Bunch-Kaufman factorization.

Source

pub fn factorize_numeric_llt<'out, E: ComplexField>( &'out self, L_values: GroupFor<E, &'out mut [E::Unit]>, A: SparseColMatRef<'_, I, E>, side: Side, regularization: LltRegularization<E>, parallelism: Parallelism, stack: PodStack<'_>, ) -> Result<LltRef<'out, I, E>, CholeskyError>

Computes a numerical LLT factorization of A, or returns a CholeskyError if the matrix is not numerically positive definite.

Source

pub fn factorize_numeric_ldlt<'out, E: ComplexField>( &'out self, L_values: GroupFor<E, &'out mut [E::Unit]>, A: SparseColMatRef<'_, I, E>, side: Side, regularization: LdltRegularization<'_, E>, parallelism: Parallelism, stack: PodStack<'_>, ) -> LdltRef<'out, I, E>

Computes a numerical LDLT factorization of A.

Source

pub fn factorize_numeric_intranode_bunch_kaufman<'out, E: ComplexField>( &'out self, L_values: GroupFor<E, &'out mut [E::Unit]>, subdiag: GroupFor<E, &'out mut [E::Unit]>, perm_forward: &'out mut [I], perm_inverse: &'out mut [I], A: SparseColMatRef<'_, I, E>, side: Side, regularization: LdltRegularization<'_, E>, parallelism: Parallelism, stack: PodStack<'_>, ) -> IntranodeBunchKaufmanRef<'out, I, E>

Computes a numerical intranodal Bunch-Kaufman factorization of A.

Source

pub fn solve_in_place_req<E: Entity>( &self, rhs_ncols: usize, ) -> Result<StackReq, SizeOverflow>

Computes the required workspace size and alignment for a dense solve in place using an LLT, LDLT or intranodal Bunch-Kaufman factorization.

Trait Implementations§

Source§

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

Source§

fn clone(&self) -> Self

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

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

Performs copy-assignment from source. Read more
Source§

impl<'a, I: Debug + Index, E: Debug + Entity> Debug for IntranodeBunchKaufmanRef<'a, I, E>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'a, I: Index, E: Entity> Deref for IntranodeBunchKaufmanRef<'a, I, E>

Source§

type Target = SymbolicCholesky<I>

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.
Source§

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

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

impl<'a, I, E> UnwindSafe for IntranodeBunchKaufmanRef<'a, I, E>
where <<E as Entity>::Group as ForCopyType>::FaerOfCopy<*const [<E as Entity>::Unit]>: UnwindSafe, E: 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, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
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.