Struct ndarray_linalg::tridiagonal::Tridiagonal

pub struct Tridiagonal<A: Scalar> {
    pub l: MatrixLayout,
    pub dl: Vec<A>,
    pub d: Vec<A>,
    pub du: Vec<A>,
}

Represents a tridiagonal matrix as 3 one-dimensional vectors. This struct also holds the layout of the raw matrix.

Fields

l: MatrixLayout

layout of raw matrix

dl: Vec<A>

(n-1) sub-diagonal elements of matrix.

d: Vec<A>

(n) diagonal elements of matrix.

du: Vec<A>

(n-1) super-diagonal elements of matrix.

Trait Implementations

impl<A: Clone + Scalar> Clone for Tridiagonal<A>

fn clone(&self) -> Tridiagonal<A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A> DeterminantTridiagonal<A> for Tridiagonal<A> where
    A: Scalar, 

fn det_tridiagonal(&self) -> Result<A>

Computes the determinant of the matrix. Unlike .det() of Determinant trait, this method doesn't returns the natural logarithm of the determinant but the determinant itself.

impl<A> FactorizeTridiagonal<A> for Tridiagonal<A> where
    A: Scalar + Lapack, 

fn factorize_tridiagonal(&self) -> Result<LUFactorizedTridiagonal<A>>

Computes the LU factorization A = P*L*U, where P is a permutation matrix.

impl<A> FactorizeTridiagonalInto<A> for Tridiagonal<A> where
    A: Scalar + Lapack, 

fn factorize_tridiagonal_into(self) -> Result<LUFactorizedTridiagonal<A>>

Computes the LU factorization A = P*L*U, where P is a permutation matrix.

impl<A, I> Index<I> for Tridiagonal<A> where
    A: Scalar,
    I: TridiagIndex, 

type Output = A

The returned type after indexing.

fn index(&self, index: I) -> &A

Performs the indexing (container[index]) operation.

impl<A, I> IndexMut<I> for Tridiagonal<A> where
    A: Scalar,
    I: TridiagIndex, 

fn index_mut(&mut self, index: I) -> &mut A

Performs the mutable indexing (container[index]) operation.

impl<A> OperationNorm for Tridiagonal<A> where
    A: Scalar + Lapack, 

type Output = A::Real

the value of norm

fn opnorm(&self, t: NormType) -> Result<Self::Output>

fn opnorm_one(&self) -> Result<Self::Output>

the one norm of a matrix (maximum column sum)

fn opnorm_inf(&self) -> Result<Self::Output>

the infinity norm of a matrix (maximum row sum)

fn opnorm_fro(&self) -> Result<Self::Output>

the Frobenius norm of a matrix (square root of sum of squares)

impl<A: PartialEq + Scalar> PartialEq<Tridiagonal<A>> for Tridiagonal<A>

fn eq(&self, other: &Tridiagonal<A>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Tridiagonal<A>) -> bool

This method tests for !=.

impl<A> SolveTridiagonal<A, Dim<[usize; 1]>> for Tridiagonal<A> where
    A: Scalar + Lapack, 

fn solve_tridiagonal<Sb: Data<Elem = A>>(
    &self,
    b: &ArrayBase<Sb, Ix1>
) -> Result<Array<A, Ix1>>

Solves a system of linear equations A * x = b with tridiagonal matrix A, where A is self, b is the argument, and x is the successful result.

fn solve_tridiagonal_into<Sb: DataMut<Elem = A>>(
    &self,
    b: ArrayBase<Sb, Ix1>
) -> Result<ArrayBase<Sb, Ix1>>

Solves a system of linear equations A * x = b with tridiagonal matrix A, where A is self, b is the argument, and x is the successful result.

fn solve_t_tridiagonal<Sb: Data<Elem = A>>(
    &self,
    b: &ArrayBase<Sb, Ix1>
) -> Result<Array<A, Ix1>>

Solves a system of linear equations A^T * x = b with tridiagonal matrix A, where A is self, b is the argument, and x is the successful result.

fn solve_t_tridiagonal_into<Sb: DataMut<Elem = A>>(
    &self,
    b: ArrayBase<Sb, Ix1>
) -> Result<ArrayBase<Sb, Ix1>>

Solves a system of linear equations A^T * x = b with tridiagonal matrix A, where A is self, b is the argument, and x is the successful result.

fn solve_h_tridiagonal<Sb: Data<Elem = A>>(
    &self,
    b: &ArrayBase<Sb, Ix1>
) -> Result<Array<A, Ix1>>

Solves a system of linear equations A^H * x = b with tridiagonal matrix A, where A is self, b is the argument, and x is the successful result.

fn solve_h_tridiagonal_into<Sb: DataMut<Elem = A>>(
    &self,
    b: ArrayBase<Sb, Ix1>
) -> Result<ArrayBase<Sb, Ix1>>

Solves a system of linear equations A^H * x = b with tridiagonal matrix A, where A is self, b is the argument, and x is the successful result.

impl<A> SolveTridiagonal<A, Dim<[usize; 2]>> for Tridiagonal<A> where
    A: Scalar + Lapack, 

fn solve_tridiagonal<Sb: Data<Elem = A>>(
    &self,
    b: &ArrayBase<Sb, Ix2>
) -> Result<Array<A, Ix2>>

Solves a system of linear equations A * x = b with tridiagonal matrix A, where A is self, b is the argument, and x is the successful result.

fn solve_tridiagonal_into<Sb: DataMut<Elem = A>>(
    &self,
    b: ArrayBase<Sb, Ix2>
) -> Result<ArrayBase<Sb, Ix2>>

Solves a system of linear equations A * x = b with tridiagonal matrix A, where A is self, b is the argument, and x is the successful result.

fn solve_t_tridiagonal<Sb: Data<Elem = A>>(
    &self,
    b: &ArrayBase<Sb, Ix2>
) -> Result<Array<A, Ix2>>

Solves a system of linear equations A^T * x = b with tridiagonal matrix A, where A is self, b is the argument, and x is the successful result.

fn solve_t_tridiagonal_into<Sb: DataMut<Elem = A>>(
    &self,
    b: ArrayBase<Sb, Ix2>
) -> Result<ArrayBase<Sb, Ix2>>

Solves a system of linear equations A^T * x = b with tridiagonal matrix A, where A is self, b is the argument, and x is the successful result.

fn solve_h_tridiagonal<Sb: Data<Elem = A>>(
    &self,
    b: &ArrayBase<Sb, Ix2>
) -> Result<Array<A, Ix2>>

Solves a system of linear equations A^H * x = b with tridiagonal matrix A, where A is self, b is the argument, and x is the successful result.

fn solve_h_tridiagonal_into<Sb: DataMut<Elem = A>>(
    &self,
    b: ArrayBase<Sb, Ix2>
) -> Result<ArrayBase<Sb, Ix2>>

Solves a system of linear equations A^H * x = b with tridiagonal matrix A, where A is self, b is the argument, and x is the successful result.

impl<A> SolveTridiagonalInplace<A, Dim<[usize; 2]>> for Tridiagonal<A> where
    A: Scalar + Lapack, 

fn solve_tridiagonal_inplace<'a, Sb>(
    &self,
    rhs: &'a mut ArrayBase<Sb, Ix2>
) -> Result<&'a mut ArrayBase<Sb, Ix2>> where
    Sb: DataMut<Elem = A>, 

Solves a system of linear equations A * x = b tridiagonal 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 solve_t_tridiagonal_inplace<'a, Sb>(
    &self,
    rhs: &'a mut ArrayBase<Sb, Ix2>
) -> Result<&'a mut ArrayBase<Sb, Ix2>> where
    Sb: DataMut<Elem = A>, 

Solves a system of linear equations A^T * x = b tridiagonal 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 solve_h_tridiagonal_inplace<'a, Sb>(
    &self,
    rhs: &'a mut ArrayBase<Sb, Ix2>
) -> Result<&'a mut ArrayBase<Sb, Ix2>> where
    Sb: DataMut<Elem = A>, 

Solves a system of linear equations A^H * x = b tridiagonal 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.

impl<A: Scalar> StructuralPartialEq for Tridiagonal<A>