Eigen  3.3.3
Eigen::SuperLUBase< _MatrixType, Derived > Class Template Reference

Detailed Description

template<typename _MatrixType, typename Derived>
class Eigen::SuperLUBase< _MatrixType, Derived >

The base class for the direct and incomplete LU factorization of SuperLU.

+ Inheritance diagram for Eigen::SuperLUBase< _MatrixType, Derived >:

List of all members.

Public Member Functions

void analyzePattern (const MatrixType &)
void compute (const MatrixType &matrix)
ComputationInfo info () const
 Reports whether previous computation was successful.
superlu_options_t & options ()

Member Function Documentation

template<typename _MatrixType, typename Derived>
void Eigen::SuperLUBase< _MatrixType, Derived >::analyzePattern ( const MatrixType &  ) [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 in Eigen::SuperILU< _MatrixType >, and Eigen::SuperLU< _MatrixType >.

template<typename _MatrixType, typename Derived>
void Eigen::SuperLUBase< _MatrixType, Derived >::compute ( const MatrixType &  matrix) [inline]

Computes the sparse Cholesky decomposition of matrix

template<typename _MatrixType, typename Derived>
ComputationInfo Eigen::SuperLUBase< _MatrixType, Derived >::info ( ) const [inline]

Reports whether previous computation was successful.

Returns:
Success if computation was succesful, NumericalIssue if the matrix.appears to be negative.
template<typename _MatrixType, typename Derived>
superlu_options_t& Eigen::SuperLUBase< _MatrixType, Derived >::options ( ) [inline]
Returns:
a reference to the Super LU option object to configure the Super LU algorithms.

The documentation for this class was generated from the following file:
 All Classes Functions Variables Typedefs Enumerations Enumerator Friends