Eigen::SuperLUBase< MatrixType_, Derived > Class Template Reference

#include <Eigen/src/SuperLUSupport/SuperLUSupport.h>

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 >:

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

Member Function Documentation

analyzePattern()

template<typename MatrixType_, typename Derived>

void Eigen::SuperLUBase< MatrixType_, Derived >::analyzePattern ( const MatrixType & )

inline

Performs a symbolic decomposition on the sparsity 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:

• /builds/libeigen/eigen/Eigen/src/SuperLUSupport/SuperLUSupport.h