W3cubDocs

/Eigen3

Eigen::SuperLUBase

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

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

void analyzePattern (const MatrixType &)
void compute (const MatrixType &matrix)
ComputationInfo info () const
Reports whether previous computation was successful. More...
superlu_options_t & options ()
- Public Member Functions inherited from Eigen::SparseSolverBase< Derived >
template<typename Rhs >
const Solve< Derived, Rhs > solve (const MatrixBase< Rhs > &b) const
template<typename Rhs >
const Solve< Derived, Rhs > solve (const SparseMatrixBase< Rhs > &b) const
SparseSolverBase ()

analyzePattern()

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()

compute()

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

Computes the sparse Cholesky decomposition of matrix

info()

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

Reports whether previous computation was successful.

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

options()

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:

© Eigen.
Licensed under the MPL2 License.
https://eigen.tuxfamily.org/dox/classEigen_1_1SuperLUBase.html