Trait linxal::eigenvalues::symmetric::SymEigen
[−]
[src]
pub trait SymEigen: Sized {
type Eigenvalue;
type Solution;
fn compute_mut<D>(mat: &mut ArrayBase<D, Ix2>, uplo: Symmetric, with_vectors: bool) -> Result<Array<Self::Eigenvalue, Ix1>, EigenError> where D: DataMut<Elem=Self>;
fn compute<D>(mat: &ArrayBase<D, Ix2>, uplo: Symmetric, with_vectors: bool) -> Result<Self::Solution, EigenError> where D: Data<Elem=Self>;
fn compute_into<D>(mat: ArrayBase<D, Ix2>, uplo: Symmetric) -> Result<Array<Self::Eigenvalue, Ix1>, EigenError> where D: DataMut<Elem=Self> + DataOwned<Elem=Self> { ... }
}Scalar trait for computing eigenvalues of a symmetric matrix.
In order to extract eigenvalues or eigenvectors from a matrix,
that matrix with must have entries implementing the Eigen trait.
Associated Types
type Eigenvalue
Scalar type of the resulting eigenvalues.
type Solution
Solution structure from the eigenvalue computation.
Required Methods
fn compute_mut<D>(mat: &mut ArrayBase<D, Ix2>, uplo: Symmetric, with_vectors: bool) -> Result<Array<Self::Eigenvalue, Ix1>, EigenError> where D: DataMut<Elem=Self>
Return the real eigenvalues of a symmetric matrix.
If with_vectors is true, the right eigenvectors of 'V' are
stored in the input matrix.
fn compute<D>(mat: &ArrayBase<D, Ix2>, uplo: Symmetric, with_vectors: bool) -> Result<Self::Solution, EigenError> where D: Data<Elem=Self>
Return the eigenvalues and, optionally, the eigenvectors of a symmetric matrix.
Remarks
The input matrix is copied before the calculation takes place.
Provided Methods
fn compute_into<D>(mat: ArrayBase<D, Ix2>, uplo: Symmetric) -> Result<Array<Self::Eigenvalue, Ix1>, EigenError> where D: DataMut<Elem=Self> + DataOwned<Elem=Self>
Return the real eigenvalues of a symmetric matrix.