BKFactorized

Struct BKFactorized 

Source
pub struct BKFactorized<S>
where S: Data,
{ pub a: ArrayBase<S, Dim<[usize; 2]>>, pub ipiv: Vec<i32>, }
Expand description

Represents the Bunch–Kaufman factorization of a Hermitian (or real symmetric) matrix as A = P * U * D * U^H * P^T.

Fields§

§a: ArrayBase<S, Dim<[usize; 2]>>§ipiv: Vec<i32>

Implementations§

Source§

impl<A, S> BKFactorized<S>
where A: Scalar + Lapack, S: Data<Elem = A>,

Source

pub fn deth(&self) -> <A as Scalar>::Real

Computes the determinant of the factorized Hermitian (or real symmetric) matrix.

Source

pub fn sln_deth(&self) -> (<A as Scalar>::Real, <A as Scalar>::Real)

Computes the (sign, natural_log) of the determinant of the factorized Hermitian (or real symmetric) matrix.

The natural_log is the natural logarithm of the absolute value of the determinant. If the determinant is zero, sign is 0 and natural_log is negative infinity.

To obtain the determinant, you can compute sign * natural_log.exp() or just call .deth() instead.

This method is more robust than .deth() to very small or very large determinants since it returns the natural logarithm of the determinant rather than the determinant itself.

Source

pub fn deth_into(self) -> <A as Scalar>::Real

Computes the determinant of the factorized Hermitian (or real symmetric) matrix.

Source

pub fn sln_deth_into(self) -> (<A as Scalar>::Real, <A as Scalar>::Real)

Computes the (sign, natural_log) of the determinant of the factorized Hermitian (or real symmetric) matrix.

The natural_log is the natural logarithm of the absolute value of the determinant. If the determinant is zero, sign is 0 and natural_log is negative infinity.

To obtain the determinant, you can compute sign * natural_log.exp() or just call .deth_into() instead.

This method is more robust than .deth_into() to very small or very large determinants since it returns the natural logarithm of the determinant rather than the determinant itself.

Trait Implementations§

Source§

impl<A, S> InverseH for BKFactorized<S>
where A: Scalar + Lapack, S: Data<Elem = A>,

Source§

type Output = ArrayBase<OwnedRepr<A>, Dim<[usize; 2]>>

Source§

fn invh(&self) -> Result<<BKFactorized<S> as InverseH>::Output, LinalgError>

Computes the inverse of the Hermitian (or real symmetric) matrix.
Source§

impl<A, S> InverseHInto for BKFactorized<S>
where A: Scalar + Lapack, S: DataMut<Elem = A>,

Source§

type Output = ArrayBase<S, Dim<[usize; 2]>>

Source§

fn invh_into(self) -> Result<ArrayBase<S, Dim<[usize; 2]>>, LinalgError>

Computes the inverse of the Hermitian (or real symmetric) matrix.
Source§

impl<A, S> SolveH<A> for BKFactorized<S>
where A: Scalar + Lapack, S: Data<Elem = A>,

Source§

fn solveh_inplace<'a, Sb>( &self, rhs: &'a mut ArrayBase<Sb, Dim<[usize; 1]>>, ) -> Result<&'a mut ArrayBase<Sb, Dim<[usize; 1]>>, LinalgError>
where Sb: DataMut<Elem = A>,

Solves a system of linear equations A * x = b with Hermitian (or real symmetric) matrix A, where A is self, b is the argument, and x is the successful result. The value of x is also assigned to the argument. Read more
Source§

fn solveh<S>( &self, b: &ArrayBase<S, Dim<[usize; 1]>>, ) -> Result<ArrayBase<OwnedRepr<A>, Dim<[usize; 1]>>, LinalgError>
where S: Data<Elem = A>,

Solves a system of linear equations A * x = b with Hermitian (or real symmetric) matrix A, where A is self, b is the argument, and x is the successful result. Read more
Source§

fn solveh_into<S>( &self, b: ArrayBase<S, Dim<[usize; 1]>>, ) -> Result<ArrayBase<S, Dim<[usize; 1]>>, LinalgError>
where S: DataMut<Elem = A>,

Solves a system of linear equations A * x = b with Hermitian (or real symmetric) matrix A, where A is self, b is the argument, and x is the successful result. Read more

Auto Trait Implementations§

§

impl<S> Freeze for BKFactorized<S>
where S: Freeze,

§

impl<S> RefUnwindSafe for BKFactorized<S>

§

impl<S> Send for BKFactorized<S>
where S: Send,

§

impl<S> Sync for BKFactorized<S>
where S: Sync,

§

impl<S> Unpin for BKFactorized<S>
where S: Unpin,

§

impl<S> UnwindSafe for BKFactorized<S>
where S: UnwindSafe, <S as RawData>::Elem: 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> 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<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V