extendr_api::prelude::sparse::linalg::solvers

Struct Cholesky

pub struct Cholesky<I, E>
where
    I: Index,
    E: Entity,
{
    symbolic: SymbolicCholesky<I>,
    values: VecGroup<E>,
}
Expand description

Sparse Cholesky factorization.

Fields§

§symbolic: SymbolicCholesky<I>§values: VecGroup<E>

Implementations§

§

impl<I, E> Cholesky<I, E>
where I: Index, E: ComplexField,

pub fn try_new_with_symbolic( symbolic: SymbolicCholesky<I>, mat: SparseColMatRef<'_, I, E>, side: Side, ) -> Result<Cholesky<I, E>, CholeskyError>

Returns the Cholesky factorization of the input matrix with the same sparsity pattern as the original one used to construct the symbolic factorization.

Only the provided side is accessed.

Trait Implementations§

§

impl<I, E> Clone for Cholesky<I, E>
where I: Clone + Index, E: Clone + Entity,

§

fn clone(&self) -> Cholesky<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<I, E> Debug for Cholesky<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<I, E> SpSolverCore<E> for Cholesky<I, E>
where I: Index, E: ComplexField,

§

fn nrows(&self) -> usize

Returns the number of rows of the matrix used to construct this decomposition.
§

fn ncols(&self) -> usize

Returns the number of columns of the matrix used to construct this decomposition.

Auto Trait Implementations§

§

impl<I, E> Freeze for Cholesky<I, E>
where <<E as Entity>::Group as ForType>::FaerOf<Vec<<E as Entity>::Unit>>: Freeze,

§

impl<I, E> RefUnwindSafe for Cholesky<I, E>
where <<E as Entity>::Group as ForType>::FaerOf<Vec<<E as Entity>::Unit>>: RefUnwindSafe, I: RefUnwindSafe,

§

impl<I, E> Send for Cholesky<I, E>

§

impl<I, E> Sync for Cholesky<I, E>

§

impl<I, E> Unpin for Cholesky<I, E>
where <<E as Entity>::Group as ForType>::FaerOf<Vec<<E as Entity>::Unit>>: Unpin,

§

impl<I, E> UnwindSafe for Cholesky<I, E>
where <<E as Entity>::Group as ForType>::FaerOf<Vec<<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
§

impl<E, Dec> SpSolver<E> for Dec
where E: ComplexField, Dec: SpSolverCore<E> + ?Sized,

§

fn solve_in_place(&self, rhs: impl ColBatchMut<E>)

Solves the equation self * X = rhs when self is square, and stores the result in rhs.
§

fn solve_conj_in_place(&self, rhs: impl ColBatchMut<E>)

Solves the equation conjugate(self) * X = rhs when self is square, and stores the result in rhs.
§

fn solve_transpose_in_place(&self, rhs: impl ColBatchMut<E>)

Solves the equation transpose(self) * X = rhs when self is square, and stores the result in rhs.
§

fn solve_conj_transpose_in_place(&self, rhs: impl ColBatchMut<E>)

Solves the equation adjoint(self) * X = rhs when self is square, and stores the result in rhs.
§

fn solve<ViewE, B>(&self, rhs: B) -> <B as ColBatch<ViewE>>::Owned
where ViewE: Conjugate<Canonical = E>, B: ColBatch<ViewE>,

Solves the equation self * X = rhs when self is square, and returns the result.
§

fn solve_conj<ViewE, B>(&self, rhs: B) -> <B as ColBatch<ViewE>>::Owned
where ViewE: Conjugate<Canonical = E>, B: ColBatch<ViewE>,

Solves the equation conjugate(self) * X = rhs when self is square, and returns the result.
§

fn solve_transpose<ViewE, B>(&self, rhs: B) -> <B as ColBatch<ViewE>>::Owned
where ViewE: Conjugate<Canonical = E>, B: ColBatch<ViewE>,

Solves the equation transpose(self) * X = rhs when self is square, and returns the result.
§

fn solve_conj_transpose<ViewE, B>( &self, rhs: B, ) -> <B as ColBatch<ViewE>>::Owned
where ViewE: Conjugate<Canonical = E>, B: ColBatch<ViewE>,

Solves the equation adjoint(self) * X = rhs when self is square, and returns the result.
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.