#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/SparseCholesky/SimplicialCholesky.h>

Inheritance diagram for Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >:

Public Types
enum	{ UpLo = _UpLo }

typedef _MatrixType	MatrixType

typedef SimplicialCholeskyBase< SimplicialCholesky >	Base

typedef MatrixType::Scalar	Scalar

typedef MatrixType::RealScalar	RealScalar

typedef MatrixType::StorageIndex	StorageIndex

typedef SparseMatrix< Scalar, ColMajor, StorageIndex >	CholMatrixType

typedef Matrix< Scalar, Dynamic, 1 >	VectorType

typedef internal::traits< SimplicialCholesky >	Traits

typedef internal::traits< SimplicialLDLT< MatrixType, UpLo > >	LDLTTraits

typedef internal::traits< SimplicialLLT< MatrixType, UpLo > >	LLTTraits

Public Types inherited from Eigen::SimplicialCholeskyBase< SimplicialCholesky< _MatrixType, _UpLo, _Ordering > >
enum

enum

typedef internal::traits< SimplicialCholesky< _MatrixType, _UpLo, _Ordering > >::MatrixType	MatrixType

typedef internal::traits< SimplicialCholesky< _MatrixType, _UpLo, _Ordering > >::OrderingType	OrderingType

typedef MatrixType::Scalar	Scalar

typedef MatrixType::RealScalar	RealScalar

typedef MatrixType::StorageIndex	StorageIndex

typedef SparseMatrix< Scalar, ColMajor, StorageIndex >	CholMatrixType

typedef CholMatrixType const *	ConstCholMatrixPtr

typedef Matrix< Scalar, Dynamic, 1 >	VectorType

typedef Matrix< StorageIndex, Dynamic, 1 >	VectorI

Public Member Functions
	SimplicialCholesky ()

	SimplicialCholesky (const MatrixType &matrix)

SimplicialCholesky &	setMode (SimplicialCholeskyMode mode)

const VectorType	vectorD () const

const CholMatrixType	rawMatrix () const

SimplicialCholesky &	compute (const MatrixType &matrix)
	Computes the sparse Cholesky decomposition of matrix. More...

void	analyzePattern (const MatrixType &a)
	Performs a symbolic decomposition on the sparcity of matrix. More...

void	factorize (const MatrixType &a)
	Performs a numeric decomposition of matrix. More...

template<typename Rhs , typename Dest >
void	_solve_impl (const MatrixBase< Rhs > &b, MatrixBase< Dest > &dest) const

template<typename Rhs , typename Dest >
void	_solve_impl (const SparseMatrixBase< Rhs > &b, SparseMatrixBase< Dest > &dest) const

Scalar	determinant () const

Public Member Functions inherited from Eigen::SimplicialCholeskyBase< SimplicialCholesky< _MatrixType, _UpLo, _Ordering > >
	SimplicialCholeskyBase ()
	Default constructor. More...

	SimplicialCholeskyBase (const MatrixType &matrix)

	~SimplicialCholeskyBase ()

SimplicialCholesky< _MatrixType, _UpLo, _Ordering > &	derived ()

const SimplicialCholesky< _MatrixType, _UpLo, _Ordering > &	derived () const

SimplicialCholesky< _MatrixType, _UpLo, _Ordering > &	derived ()

const SimplicialCholesky< _MatrixType, _UpLo, _Ordering > &	derived () const

Index	cols () const

Index	rows () const

ComputationInfo	info () const
	Reports whether previous computation was successful. More...

const PermutationMatrix< Dynamic, Dynamic, StorageIndex > &	permutationP () const

const PermutationMatrix< Dynamic, Dynamic, StorageIndex > &	permutationPinv () const

SimplicialCholesky< _MatrixType, _UpLo, _Ordering > &	setShift (const RealScalar &offset, const RealScalar &scale=1)
	Sets the shift parameters that will be used to adjust the diagonal coefficients during the numerical factorization. More...

void	dumpMemory (Stream &s)

void	_solve_impl (const MatrixBase< Rhs > &b, MatrixBase< Dest > &dest) const

void	_solve_impl (const SparseMatrixBase< Rhs > &b, SparseMatrixBase< Dest > &dest) const

Public Member Functions inherited from Eigen::SparseSolverBase< SimplicialCholesky< _MatrixType, _UpLo, _Ordering > >
	SparseSolverBase ()
	Default constructor. More...

	~SparseSolverBase ()

SimplicialCholesky< _MatrixType, _UpLo, _Ordering > &	derived ()

const SimplicialCholesky< _MatrixType, _UpLo, _Ordering > &	derived () const

const Solve< SimplicialCholesky< _MatrixType, _UpLo, _Ordering >, Rhs >	solve (const MatrixBase< Rhs > &b) const

const Solve< SimplicialCholesky< _MatrixType, _UpLo, _Ordering >, Rhs >	solve (const SparseMatrixBase< Rhs > &b) const

void	_solve_impl (const SparseMatrixBase< Rhs > &b, SparseMatrixBase< Dest > &dest) const

Protected Attributes
bool	m_LDLT

Protected Attributes inherited from Eigen::SimplicialCholeskyBase< SimplicialCholesky< _MatrixType, _UpLo, _Ordering > >
ComputationInfo	m_info

bool	m_factorizationIsOk

bool	m_analysisIsOk

CholMatrixType	m_matrix

VectorType	m_diag

VectorI	m_parent

VectorI	m_nonZerosPerCol

PermutationMatrix< Dynamic, Dynamic, StorageIndex >	m_P

PermutationMatrix< Dynamic, Dynamic, StorageIndex >	m_Pinv

RealScalar	m_shiftOffset

RealScalar	m_shiftScale

Protected Attributes inherited from Eigen::SparseSolverBase< SimplicialCholesky< _MatrixType, _UpLo, _Ordering > >
bool	m_isInitialized

Additional Inherited Members
Protected Member Functions inherited from Eigen::SimplicialCholeskyBase< SimplicialCholesky< _MatrixType, _UpLo, _Ordering > >
void	compute (const MatrixType &matrix)
	Computes the sparse Cholesky decomposition of matrix. More...

void	factorize (const MatrixType &a)

void	factorize_preordered (const CholMatrixType &a)

void	analyzePattern (const MatrixType &a, bool doLDLT)

void	analyzePattern_preordered (const CholMatrixType &a, bool doLDLT)

void	ordering (const MatrixType &a, ConstCholMatrixPtr &pmat, CholMatrixType &ap)

Detailed Description

template<typename _MatrixType, int _UpLo, typename _Ordering>
class Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >

Deprecated:: use SimplicialLDLT or class SimplicialLLT

See also: class SimplicialLDLT, class SimplicialLLT

Member Typedef Documentation

◆ Base

template<typename _MatrixType , int _UpLo, typename _Ordering >

typedef SimplicialCholeskyBase<SimplicialCholesky> Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::Base

◆ CholMatrixType

template<typename _MatrixType , int _UpLo, typename _Ordering >

typedef SparseMatrix<Scalar,ColMajor,StorageIndex> Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::CholMatrixType

◆ LDLTTraits

template<typename _MatrixType , int _UpLo, typename _Ordering >

typedef internal::traits<SimplicialLDLT<MatrixType,UpLo> > Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::LDLTTraits

◆ LLTTraits

template<typename _MatrixType , int _UpLo, typename _Ordering >

typedef internal::traits<SimplicialLLT<MatrixType,UpLo> > Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::LLTTraits

◆ MatrixType

template<typename _MatrixType , int _UpLo, typename _Ordering >

typedef _MatrixType Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::MatrixType

◆ RealScalar

template<typename _MatrixType , int _UpLo, typename _Ordering >

typedef MatrixType::RealScalar Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::RealScalar

◆ Scalar

template<typename _MatrixType , int _UpLo, typename _Ordering >

typedef MatrixType::Scalar Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::Scalar

◆ StorageIndex

template<typename _MatrixType , int _UpLo, typename _Ordering >

typedef MatrixType::StorageIndex Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::StorageIndex

◆ Traits

template<typename _MatrixType , int _UpLo, typename _Ordering >

typedef internal::traits<SimplicialCholesky> Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::Traits

◆ VectorType

template<typename _MatrixType , int _UpLo, typename _Ordering >

typedef Matrix<Scalar,Dynamic,1> Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::VectorType

Member Enumeration Documentation

◆ anonymous enum

template<typename _MatrixType , int _UpLo, typename _Ordering >

anonymous enum

Enumerator
UpLo

Constructor & Destructor Documentation

◆ SimplicialCholesky() [1/2]

template<typename _MatrixType , int _UpLo, typename _Ordering >

Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::SimplicialCholesky ( )

inline

◆ SimplicialCholesky() [2/2]

template<typename _MatrixType , int _UpLo, typename _Ordering >

Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::SimplicialCholesky ( const MatrixType & matrix )

inlineexplicit

Member Function Documentation

◆ _solve_impl() [1/2]

template<typename _MatrixType , int _UpLo, typename _Ordering >

template<typename Rhs , typename Dest >

void Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::_solve_impl	(	const MatrixBase< Rhs > &	b,
		MatrixBase< Dest > &	dest
	)		const

inline

◆ _solve_impl() [2/2]

template<typename _MatrixType , int _UpLo, typename _Ordering >

template<typename Rhs , typename Dest >

void Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::_solve_impl	(	const SparseMatrixBase< Rhs > &	b,
		SparseMatrixBase< Dest > &	dest
	)		const

inline

◆ 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 sparcity 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.

◆ determinant()

template<typename _MatrixType , int _UpLo, typename _Ordering >

Scalar Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::determinant ( ) const

inline

◆ 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 has the same sparcity than the matrix on which the symbolic decomposition has been performed.

See also: analyzePattern()

◆ rawMatrix()

template<typename _MatrixType , int _UpLo, typename _Ordering >

const CholMatrixType Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::rawMatrix ( ) const

inline

◆ setMode()

template<typename _MatrixType , int _UpLo, typename _Ordering >

SimplicialCholesky & Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::setMode ( SimplicialCholeskyMode mode )

inline

◆ vectorD()

template<typename _MatrixType , int _UpLo, typename _Ordering >

const VectorType Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::vectorD ( ) const

inline

Member Data Documentation

◆ m_LDLT

template<typename _MatrixType , int _UpLo, typename _Ordering >

bool Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >::m_LDLT

protected

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

/home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/SparseCholesky/SimplicialCholesky.h

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Base

◆ CholMatrixType

◆ LDLTTraits

◆ LLTTraits

◆ MatrixType

◆ RealScalar

◆ Scalar

◆ StorageIndex

◆ Traits

◆ VectorType

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ SimplicialCholesky() [1/2]

◆ SimplicialCholesky() [2/2]

Member Function Documentation

◆ _solve_impl() [1/2]

◆ _solve_impl() [2/2]

◆ analyzePattern()

◆ compute()

◆ determinant()

◆ factorize()

◆ rawMatrix()

◆ setMode()

◆ vectorD()

Member Data Documentation

◆ m_LDLT