Struct ndarray_linalg::solveh::BKFactorized

[+] Show declaration

pub struct BKFactorized<S: Data> {
    pub a: ArrayBase<S, Ix2>,
    pub ipiv: Pivot,
}

[−] 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, Ix2>

ipiv: Pivot

Methods

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

pub fn deth(&self) -> A::Real[−]

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

pub fn sln_deth(&self) -> (A::Real, A::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.

pub fn deth_into(self) -> A::Real[−]

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

pub fn sln_deth_into(self) -> (A::Real, A::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

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

[+] Show hidden undocumented items

type Output = Array2<A>

fn invh(&self) -> Result<Self::Output>[−]

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

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

[+] Show hidden undocumented items

type Output = ArrayBase<S, Ix2>

fn invh_into(self) -> Result<ArrayBase<S, Ix2>>[−]

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

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

[+] Show hidden undocumented items

fn solveh_inplace<'a, Sb>(
    &self,
    rhs: &'a mut ArrayBase<Sb, Ix1>
) -> Result<&'a mut ArrayBase<Sb, Ix1>> 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.

fn solveh<S: Data<Elem = A>>(&self, b: &ArrayBase<S, Ix1>) -> Result<Array1<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.

fn solveh_into<S: DataMut<Elem = A>>(
    &self,
    b: ArrayBase<S, Ix1>
) -> Result<ArrayBase<S, Ix1>>[−]

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.