tngmath::SparseSolver Class Reference
The base class for sparse solvers. It provides a unified interface which can be used by generic algorithms. More...
#include <sparsesolver.hpp>
Inheritance diagram for tngmath::SparseSolver:
Collaboration diagram for tngmath::SparseSolver:
Public Types | |
| typedef double | TScalar |
|
typedef Eigen::SparseMatrix < TScalar, Eigen::LowerTriangular > | TSparseLowerMatrix |
|
typedef Eigen::SparseMatrix < TScalar, Eigen::LowerTriangular|Eigen::SelfAdjoint > | TSparseLowerSelfAdjointMatrix |
|
typedef Eigen::SparseMatrix < TScalar > | TSparseMatrix |
|
typedef Eigen::SparseMatrix < TScalar, Eigen::SelfAdjoint > | TSparseSelfAdjointMatrix |
|
typedef Eigen::SparseMatrix < TScalar, Eigen::UpperTriangular > | TSparseUpperMatrix |
|
typedef Eigen::SparseMatrix < TScalar, Eigen::UpperTriangular|Eigen::SelfAdjoint > | TSparseUpperSelfAdjointMatrix |
Public Member Functions | |
| virtual bool | Compute (const SparseMatrixBase &) |
| computes the factorization, returns true if succeeded | |
| bool | Solve (const MatrixBase &b, MatrixBase **x) |
| Defines a wrapper for Solve() using pointers. | |
| virtual bool | Solve (const MatrixBase &b, MatrixBase &x) |
| virtual bool | SolveInPlace (MatrixBase &b) |
| SparseSolver () | |
| default constructor | |
| virtual std::string | typeIdent () const |
| returns the name of the datatype | |
| virtual | ~SparseSolver () |
| destructor | |
Protected Member Functions | |
| void | Init () |
| const bool & | succeeded_factorization () const |
| bool & | succeeded_factorization () |
Static Protected Member Functions | |
| static SparseMatrixBase | getSparseScalarMatrix () |
Protected Attributes | |
| std::pair< int, int > | m_dimensions |
| dimensions of input object: | |
| bool | m_succeeded_factorization |
Static Protected Attributes | |
| static const SparseMatrixBase | sparseScalarMatrix |
Detailed Description
The base class for sparse solvers. It provides a unified interface which can be used by generic algorithms.Member Function Documentation
| virtual bool tngmath::SparseSolver::Solve | ( | const MatrixBase & | b, | |
| MatrixBase & | x | |||
| ) | [virtual] |
Factorizes this matrix and solves the given vector on return; returns true if succeeded
Reimplemented in tngmath::SparseLLT, tngmath::SparseLU, tngmath::SparseSuperLU, tngmath::SparseLUUmfPack, and tngmath::SparseLUMUMPS.
| virtual bool tngmath::SparseSolver::SolveInPlace | ( | MatrixBase & | b | ) | [virtual] |
Factorizes this matrix and solves the given vector in place; returns true if succeeded
Reimplemented in tngmath::SparseLLT, tngmath::SparseUpperLLT, tngmath::SparseLowerLLT, tngmath::SparseLLTCholmod, tngmath::SparseUpperLLTCholmod, tngmath::SparseLowerLLTCholmod, tngmath::SparseLU, and tngmath::SparseLUMUMPS.
The documentation for this class was generated from the following file:
- modules/tngmath/tngmath/sparsesolver.hpp
