Public Member Functions | List of all members
SuperLUBase< _MatrixType, Derived > Class Template Reference

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

#include <SuperLUSupport.h>

Inherits noncopyable.

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 ()
template<typename Rhs >
const internal::solve_retval
< SuperLUBase, Rhs > 
solve (const MatrixBase< Rhs > &b) const

Detailed Description

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

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

Member Function Documentation

void analyzePattern ( const MatrixType &  )
inline
Returns
the solution x of $ A x = b $ using the current decomposition of A.
See Also
compute()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 SuperILU< _MatrixType >, and SuperLU< _MatrixType >.

Referenced by SuperLU< _MatrixType >::analyzePattern(), and SuperILU< _MatrixType >::analyzePattern().

void compute ( const MatrixType &  matrix)
inline

Computes the sparse Cholesky decomposition of matrix

ComputationInfo info ( ) const
inline

Reports whether previous computation was successful.

Returns
Success if computation was succesful, NumericalIssue if the matrix.appears to be negative.
superlu_options_t& options ( )
inline
Returns
a reference to the Super LU option object to configure the Super LU algorithms.
const internal::solve_retval<SuperLUBase, Rhs> solve ( const MatrixBase< Rhs > &  b) const
inline
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: