Struct rgsl::types::eigen_symmetric_workspace::EigenNonSymmVWorkspace

pub struct EigenNonSymmVWorkspace { /* fields omitted */ }

Methods

impl EigenNonSymmVWorkspace

fn new(n: usize) -> Option<EigenNonSymmVWorkspace>

This function allocates a workspace for computing eigenvalues and eigenvectors of n-by-n real nonsymmetric matrices. The size of the workspace is O(5n).

fn params(&mut self, balance: i32)

This function sets parameters which determine how the eigenvalue problem is solved in subsequent calls to gsl_eigen_nonsymmv. If balance is set to 1, a balancing transformation is applied to the matrix. See gsl_eigen_nonsymm_params for more information. Balancing is turned off by default since it does not preserve the orthogonality of the Schur vectors.

fn nonsymmv(
    &mut self,
    A: &mut MatrixF64,
    eval: &mut VectorComplexF64,
    evec: &mut MatrixComplexF64
) -> Value

This function computes eigenvalues and right eigenvectors of the n-by-n real nonsymmetric matrix A. It first calls gsl_eigen_nonsymm to compute the eigenvalues, Schur form T, and Schur vectors. Then it finds eigenvectors of T and backtransforms them using the Schur vectors. The Schur vectors are destroyed in the process, but can be saved by using gsl_eigen_nonsymmv_Z. The computed eigenvectors are normalized to have unit magnitude. On output, the upper portion of A contains the Schur form T. If gsl_eigen_nonsymm fails, no eigenvectors are computed, and an error code is returned.

fn nonsymmv_Z(
    &mut self,
    A: &mut MatrixF64,
    eval: &mut VectorComplexF64,
    evec: &mut MatrixComplexF64,
    Z: &mut MatrixF64
) -> Value

This function is identical to gsl_eigen_nonsymmv except that it also saves the Schur vectors into Z.

Trait Implementations

impl Drop for EigenNonSymmVWorkspace

fn drop(&mut self)

A method called when the value goes out of scope.