$treeview $search $mathjax
Eigen  3.2.5
$projectbrief
$projectbrief
$searchbox

SuperLU< _MatrixType > Class Template Reference
[SuperLUSupport module]

A sparse direct LU factorization and solver based on the SuperLU library. More...

Inheritance diagram for SuperLU< _MatrixType >:

List of all members.

Public Member Functions

void analyzePattern (const MatrixType &matrix)
void compute (const MatrixType &matrix)
void factorize (const MatrixType &matrix)
ComputationInfo info () const
 Reports whether previous computation was successful.
superlu_options_t & options ()
const
internal::sparse_solve_retval
< SuperLUBase, Rhs > 
solve (const SparseMatrixBase< Rhs > &b) const
const internal::solve_retval
< SuperLUBase, Rhs > 
solve (const MatrixBase< Rhs > &b) const

Detailed Description

template<typename _MatrixType>
class Eigen::SuperLU< _MatrixType >

A sparse direct LU factorization and solver based on the SuperLU library.

This class allows to solve for A.X = B sparse linear problems via a direct LU factorization using the SuperLU library. The sparse matrix A must be squared and invertible. The vectors or matrices X and B can be either dense or sparse.

Template Parameters:
_MatrixType the type of the sparse matrix A, it must be a SparseMatrix<>
See also:
Sparse solvers

Member Function Documentation

void analyzePattern ( const MatrixType &  matrix  )  [inline]

Performs a symbolic decomposition on the sparcity of matrix.

This function is particularly useful when solving for several problems having the same structure.

See also:
factorize()

Reimplemented from SuperLUBase< _MatrixType, SuperLU< _MatrixType > >.

References SuperLUBase< _MatrixType, Derived >::analyzePattern(), and Eigen::InvalidInput.

void compute ( const MatrixType &  matrix  )  [inline, inherited]

Computes the sparse Cholesky decomposition of matrix

void factorize ( const MatrixType &  matrix  )  [inline]

Performs a numeric decomposition of matrix

The given matrix must has the same sparcity than the matrix on which the symbolic decomposition has been performed.

See also:
analyzePattern()

References PlainObjectBase< Derived >::data(), SuperLUBase< _MatrixType, SuperLU< _MatrixType > >::info(), Eigen::InvalidInput, Eigen::NumericalIssue, and Eigen::Success.

ComputationInfo info (  )  const [inline, inherited]

Reports whether previous computation was successful.

Returns:
Success if computation was succesful, NumericalIssue if the matrix.appears to be negative.

Referenced by SuperLU< _MatrixType >::factorize().

superlu_options_t& options (  )  [inline, inherited]
Returns:
a reference to the Super LU option object to configure the Super LU algorithms.
const internal::sparse_solve_retval<SuperLUBase, Rhs> solve ( const SparseMatrixBase< Rhs > &  b  )  const [inline, inherited]
Returns:
the solution x of $ A x = b $ using the current decomposition of A.
See also:
compute()
const internal::solve_retval<SuperLUBase, Rhs> solve ( const MatrixBase< Rhs > &  b  )  const [inline, inherited]
Returns:
the solution x of $ A x = b $ using the current decomposition of A.
See also:
compute()

The documentation for this class was generated from the following file: