template<typename _MatrixType, int _UpLo, typename Derived>
class Eigen::CholmodBase< _MatrixType, _UpLo, Derived >
The base class for the direct Cholesky factorization of Cholmod.
- See also
- class CholmodSupernodalLLT, class CholmodSimplicialLDLT, class CholmodSimplicialLLT
template<typename _MatrixType, int _UpLo, typename Derived>
void Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::analyzePattern |
( |
const MatrixType & |
matrix | ) |
|
|
inline |
template<typename _MatrixType, int _UpLo, typename Derived>
Returns a reference to the Cholmod's configuration structure to get a full control over the performed operations. See the Cholmod user guide for details.
template<typename _MatrixType, int _UpLo, typename Derived>
Derived& Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::compute |
( |
const MatrixType & |
matrix | ) |
|
|
inline |
Computes the sparse Cholesky decomposition of matrix
template<typename _MatrixType, int _UpLo, typename Derived>
void Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::factorize |
( |
const MatrixType & |
matrix | ) |
|
|
inline |
template<typename _MatrixType, int _UpLo, typename Derived>
Reports whether previous computation was successful.
- Returns
Success
if computation was succesful, NumericalIssue
if the matrix.appears to be negative.
template<typename _MatrixType, int _UpLo, typename Derived>
Derived& Eigen::CholmodBase< _MatrixType, _UpLo, Derived >::setShift |
( |
const RealScalar & |
offset | ) |
|
|
inline |
Sets the shift parameter that will be used to adjust the diagonal coefficients during the numerical factorization.
During the numerical factorization, an offset term is added to the diagonal coefficients:
d_ii
= offset + d_ii
The default is offset=0.
- Returns
- a reference to
*this
.
template<typename Derived>
template<typename Rhs >
- Returns
- an expression of the solution x of
using the current decomposition of A.
- See also
- compute()
template<typename Derived>
template<typename Rhs >
- Returns
- an expression of the solution x of
using the current decomposition of A.
- See also
- compute()
The documentation for this class was generated from the following file: