Eigen::SimplicialCholesky< MatrixType_, UpLo_, Ordering_ > Class Template Reference

#include <Eigen/src/SparseCholesky/SimplicialCholesky.h>

Detailed Description

template<typename MatrixType_, int UpLo_, typename Ordering_>
class Eigen::SimplicialCholesky< MatrixType_, UpLo_, Ordering_ >

See also

class SimplicialLDLT, class SimplicialLLT

Inheritance diagram for Eigen::SimplicialCholesky< MatrixType_, UpLo_, Ordering_ >:

Public Member Functions
void	analyzePattern (const MatrixType &a)
SimplicialCholesky &	compute (const MatrixType &matrix)
void	factorize (const MatrixType &a)
Public Member Functions inherited from Eigen::SimplicialCholeskyBase< SimplicialCholesky< MatrixType_, UpLo_, Ordering_ > >
ComputationInfo	info () const
	Reports whether previous computation was successful.
const PermutationMatrix< Dynamic, Dynamic, StorageIndex > &	permutationP () const
const PermutationMatrix< Dynamic, Dynamic, StorageIndex > &	permutationPinv () const
SimplicialCholesky< MatrixType_, UpLo_, Ordering_ > &	setShift (const DiagonalScalar &offset, const DiagonalScalar &scale=1)
	SimplicialCholeskyBase ()
Public Member Functions inherited from Eigen::SparseSolverBase< SimplicialCholesky< MatrixType_, UpLo_, Ordering_ > >
Solve< SimplicialCholesky< MatrixType_, UpLo_, Ordering_ >, Rhs >	solve (const MatrixBase< Rhs > &b) const
Solve< SimplicialCholesky< MatrixType_, UpLo_, Ordering_ >, Rhs >	solve (const SparseMatrixBase< Rhs > &b) const
	SparseSolverBase ()=default

Additional Inherited Members
Protected Member Functions inherited from Eigen::SimplicialCholeskyBase< SimplicialCholesky< MatrixType_, UpLo_, Ordering_ > >
void	compute (const MatrixType &matrix)

Member Function Documentation

analyzePattern()

template<typename MatrixType_, int UpLo_, typename Ordering_>

void Eigen::SimplicialCholesky< MatrixType_, UpLo_, Ordering_ >::analyzePattern ( const MatrixType & a )

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_, int UpLo_, typename Ordering_>

SimplicialCholesky & Eigen::SimplicialCholesky< MatrixType_, UpLo_, Ordering_ >::compute ( const MatrixType & matrix )

inline

Computes the sparse Cholesky decomposition of matrix

factorize()

template<typename MatrixType_, int UpLo_, typename Ordering_>

void Eigen::SimplicialCholesky< MatrixType_, UpLo_, Ordering_ >::factorize ( const MatrixType & a )

inline

Performs a numeric decomposition of matrix

The given matrix must have the same sparsity as the matrix on which the symbolic decomposition has been performed.

See also

analyzePattern()

---

The documentation for this class was generated from the following file:

• /builds/libeigen/eigen/Eigen/src/SparseCholesky/SimplicialCholesky.h