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

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

Contents

Base classes

template<typename Derived>
class SparseSolverBase
A base class for sparse solvers.

Public functions

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

Function documentation

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

Performs a symbolic decomposition on the sparcity of matrix.

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

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

Computes the sparse Cholesky decomposition of matrix

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

Reports whether previous computation was successful.

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

template<typename _MatrixType, typename Derived>
superlu_options_t& Eigen::SuperLUBase<_MatrixType, Derived>::options()

Returns a reference to the Super LU option object to configure the Super LU algorithms.