extendr_api::prelude::sparse::linalg::cholesky

Struct BunchKaufmanRegularization

pub struct BunchKaufmanRegularization<'a, E>where
    E: ComplexField,{
    pub dynamic_regularization_signs: Option<&'a mut [i8]>,
    pub dynamic_regularization_delta: <E as ComplexField>::Real,
    pub dynamic_regularization_epsilon: <E as ComplexField>::Real,
}

Expand description

Dynamic Bunch-Kaufman regularization. Values below epsilon in absolute value, or with the wrong sign are set to delta with their corrected sign.

Fields§

§dynamic_regularization_signs: Option<&'a mut [i8]>

Expected signs for the diagonal at each step of the decomposition.

§dynamic_regularization_delta: <E as ComplexField>::Real

Regularized value.

§dynamic_regularization_epsilon: <E as ComplexField>::Real

Regularization threshold.

Trait Implementations§

§

impl<'a, E> Debug for BunchKaufmanRegularization<'a, E>
where E: Debug + ComplexField, <E as ComplexField>::Real: Debug,

§

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

Formats the value using the given formatter. Read more

§

impl<E> Default for BunchKaufmanRegularization<'_, E>
where E: ComplexField,

§

fn default() -> BunchKaufmanRegularization<'_, E>

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<'a, E> Freeze for BunchKaufmanRegularization<'a, E>
where <E as ComplexField>::Real: Freeze,

§

impl<'a, E> RefUnwindSafe for BunchKaufmanRegularization<'a, E>
where <E as ComplexField>::Real: RefUnwindSafe,

§

impl<'a, E> Send for BunchKaufmanRegularization<'a, E>

§

impl<'a, E> Sync for BunchKaufmanRegularization<'a, E>

§

impl<'a, E> Unpin for BunchKaufmanRegularization<'a, E>
where <E as ComplexField>::Real: Unpin,

§

impl<'a, E> !UnwindSafe for BunchKaufmanRegularization<'a, E>

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> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into 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

§