Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
Eigen::PardisoImpl< Derived > Class Template Reference

#include <PardisoSupport.h>

Inheritance diagram for Eigen::PardisoImpl< Derived >:
Inheritance graph
[legend]

Public Types

enum  { ScalarIsComplex = NumTraits<Scalar>::IsComplex, ColsAtCompileTime = Dynamic, MaxColsAtCompileTime = Dynamic }
 
typedef Matrix< StorageIndex, MatrixType::RowsAtCompileTime, 1 > IntColVectorType
 
typedef Matrix< StorageIndex, 1, MatrixType::ColsAtCompileTime > IntRowVectorType
 
typedef Traits::MatrixType MatrixType
 
typedef Array< StorageIndex, 64, 1, DontAlign > ParameterType
 
typedef Traits::RealScalar RealScalar
 
typedef Traits::Scalar Scalar
 
typedef SparseMatrix< Scalar, RowMajor, StorageIndex > SparseMatrixType
 
typedef Traits::StorageIndex StorageIndex
 
typedef Matrix< Scalar, Dynamic, 1 > VectorType
 

Public Member Functions

template<typename Rhs , typename Dest >
void _solve_impl (const MatrixBase< Rhs > &b, MatrixBase< Dest > &dest) const
 
template<typename BDerived , typename XDerived >
void _solve_impl (const MatrixBase< BDerived > &b, MatrixBase< XDerived > &x) const
 
Derived & analyzePattern (const MatrixType &matrix)
 
Index cols () const
 
Derived & compute (const MatrixType &matrix)
 
Derived & factorize (const MatrixType &matrix)
 
ComputationInfo info () const
 Reports whether previous computation was successful. More...
 
 PardisoImpl ()
 
ParameterType & pardisoParameterArray ()
 
Index rows () const
 
 ~PardisoImpl ()
 
- Public Member Functions inherited from Eigen::SparseSolverBase< Derived >
template<typename Rhs , typename Dest >
void _solve_impl (const SparseMatrixBase< Rhs > &b, SparseMatrixBase< Dest > &dest) const
 
Derived & derived ()
 
const Derived & derived () const
 
template<typename Rhs >
const Solve< Derived, Rhs > solve (const MatrixBase< Rhs > &b) const
 
template<typename Rhs >
const Solve< Derived, Rhs > solve (const SparseMatrixBase< Rhs > &b) const
 
 SparseSolverBase ()
 
 ~SparseSolverBase ()
 

Protected Types

typedef SparseSolverBase< Derived > Base
 
typedef internal::pardiso_traits< Derived > Traits
 

Protected Member Functions

void manageErrorCode (Index error) const
 
void pardisoInit (int type)
 
void pardisoRelease ()
 

Protected Attributes

bool m_analysisIsOk
 
bool m_factorizationIsOk
 
ComputationInfo m_info
 
ParameterType m_iparm
 
SparseMatrixType m_matrix
 
StorageIndex m_msglvl
 
IntColVectorType m_perm
 
void * m_pt [64]
 
Index m_size
 
StorageIndex m_type
 
- Protected Attributes inherited from Eigen::SparseSolverBase< Derived >
bool m_isInitialized
 

Detailed Description

template<class Derived>
class Eigen::PardisoImpl< Derived >

Definition at line 99 of file PardisoSupport.h.

Member Typedef Documentation

◆ Base

template<class Derived>
typedef SparseSolverBase<Derived> Eigen::PardisoImpl< Derived >::Base
protected

Definition at line 102 of file PardisoSupport.h.

◆ IntColVectorType

template<class Derived>
typedef Matrix<StorageIndex, MatrixType::RowsAtCompileTime, 1> Eigen::PardisoImpl< Derived >::IntColVectorType

Definition at line 117 of file PardisoSupport.h.

◆ IntRowVectorType

template<class Derived>
typedef Matrix<StorageIndex, 1, MatrixType::ColsAtCompileTime> Eigen::PardisoImpl< Derived >::IntRowVectorType

Definition at line 116 of file PardisoSupport.h.

◆ MatrixType

template<class Derived>
typedef Traits::MatrixType Eigen::PardisoImpl< Derived >::MatrixType

Definition at line 110 of file PardisoSupport.h.

◆ ParameterType

template<class Derived>
typedef Array<StorageIndex,64,1,DontAlign> Eigen::PardisoImpl< Derived >::ParameterType

Definition at line 118 of file PardisoSupport.h.

◆ RealScalar

template<class Derived>
typedef Traits::RealScalar Eigen::PardisoImpl< Derived >::RealScalar

Definition at line 112 of file PardisoSupport.h.

◆ Scalar

template<class Derived>
typedef Traits::Scalar Eigen::PardisoImpl< Derived >::Scalar

Definition at line 111 of file PardisoSupport.h.

◆ SparseMatrixType

template<class Derived>
typedef SparseMatrix<Scalar,RowMajor,StorageIndex> Eigen::PardisoImpl< Derived >::SparseMatrixType

Definition at line 114 of file PardisoSupport.h.

◆ StorageIndex

template<class Derived>
typedef Traits::StorageIndex Eigen::PardisoImpl< Derived >::StorageIndex

Definition at line 113 of file PardisoSupport.h.

◆ Traits

template<class Derived>
typedef internal::pardiso_traits<Derived> Eigen::PardisoImpl< Derived >::Traits
protected

Definition at line 106 of file PardisoSupport.h.

◆ VectorType

template<class Derived>
typedef Matrix<Scalar,Dynamic,1> Eigen::PardisoImpl< Derived >::VectorType

Definition at line 115 of file PardisoSupport.h.

Member Enumeration Documentation

◆ anonymous enum

template<class Derived>
anonymous enum
Enumerator
ScalarIsComplex 
ColsAtCompileTime 
MaxColsAtCompileTime 

Definition at line 119 of file PardisoSupport.h.

Constructor & Destructor Documentation

◆ PardisoImpl()

template<class Derived>
Eigen::PardisoImpl< Derived >::PardisoImpl ( )
inline

Definition at line 125 of file PardisoSupport.h.

◆ ~PardisoImpl()

template<class Derived>
Eigen::PardisoImpl< Derived >::~PardisoImpl ( )
inline

Definition at line 134 of file PardisoSupport.h.

Member Function Documentation

◆ _solve_impl() [1/2]

template<class Derived>
template<typename Rhs , typename Dest >
void Eigen::PardisoImpl< Derived >::_solve_impl ( const MatrixBase< Rhs > &  b,
MatrixBase< Dest > &  dest 
) const

◆ _solve_impl() [2/2]

template<class Derived>
template<typename BDerived , typename XDerived >
void Eigen::PardisoImpl< Derived >::_solve_impl ( const MatrixBase< BDerived > &  b,
MatrixBase< XDerived > &  x 
) const

Definition at line 322 of file PardisoSupport.h.

◆ analyzePattern()

template<class Derived >
Derived & Eigen::PardisoImpl< Derived >::analyzePattern ( const MatrixType &  matrix)

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()

Definition at line 281 of file PardisoSupport.h.

◆ cols()

template<class Derived>
Index Eigen::PardisoImpl< Derived >::cols ( void  ) const
inline

Definition at line 139 of file PardisoSupport.h.

◆ compute()

template<class Derived >
Derived & Eigen::PardisoImpl< Derived >::compute ( const MatrixType &  matrix)

Definition at line 260 of file PardisoSupport.h.

◆ factorize()

template<class Derived >
Derived & Eigen::PardisoImpl< Derived >::factorize ( const MatrixType &  matrix)

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()

Definition at line 303 of file PardisoSupport.h.

◆ info()

template<class Derived>
ComputationInfo Eigen::PardisoImpl< Derived >::info ( ) const
inline

Reports whether previous computation was successful.

Returns
Success if computation was successful, NumericalIssue if the matrix appears to be negative.

Definition at line 147 of file PardisoSupport.h.

◆ manageErrorCode()

template<class Derived>
void Eigen::PardisoImpl< Derived >::manageErrorCode ( Index  error) const
inlineprotected

Definition at line 232 of file PardisoSupport.h.

◆ pardisoInit()

template<class Derived>
void Eigen::PardisoImpl< Derived >::pardisoInit ( int  type)
inlineprotected

Definition at line 193 of file PardisoSupport.h.

◆ pardisoParameterArray()

template<class Derived>
ParameterType& Eigen::PardisoImpl< Derived >::pardisoParameterArray ( )
inline
Warning
for advanced usage only.
Returns
a reference to the parameter array controlling PARDISO. See the PARDISO manual to know how to use it.

Definition at line 156 of file PardisoSupport.h.

◆ pardisoRelease()

template<class Derived>
void Eigen::PardisoImpl< Derived >::pardisoRelease ( )
inlineprotected

Definition at line 183 of file PardisoSupport.h.

◆ rows()

template<class Derived>
Index Eigen::PardisoImpl< Derived >::rows ( void  ) const
inline

Definition at line 140 of file PardisoSupport.h.

Member Data Documentation

◆ m_analysisIsOk

template<class Derived>
bool Eigen::PardisoImpl< Derived >::m_analysisIsOk
protected

Definition at line 250 of file PardisoSupport.h.

◆ m_factorizationIsOk

template<class Derived>
bool Eigen::PardisoImpl< Derived >::m_factorizationIsOk
protected

Definition at line 250 of file PardisoSupport.h.

◆ m_info

template<class Derived>
ComputationInfo Eigen::PardisoImpl< Derived >::m_info
mutableprotected

Definition at line 249 of file PardisoSupport.h.

◆ m_iparm

template<class Derived>
ParameterType Eigen::PardisoImpl< Derived >::m_iparm
mutableprotected

Definition at line 253 of file PardisoSupport.h.

◆ m_matrix

template<class Derived>
SparseMatrixType Eigen::PardisoImpl< Derived >::m_matrix
mutableprotected

Definition at line 248 of file PardisoSupport.h.

◆ m_msglvl

template<class Derived>
StorageIndex Eigen::PardisoImpl< Derived >::m_msglvl
protected

Definition at line 251 of file PardisoSupport.h.

◆ m_perm

template<class Derived>
IntColVectorType Eigen::PardisoImpl< Derived >::m_perm
mutableprotected

Definition at line 254 of file PardisoSupport.h.

◆ m_pt

template<class Derived>
void* Eigen::PardisoImpl< Derived >::m_pt[64]
mutableprotected

Definition at line 252 of file PardisoSupport.h.

◆ m_size

template<class Derived>
Index Eigen::PardisoImpl< Derived >::m_size
protected

Definition at line 255 of file PardisoSupport.h.

◆ m_type

template<class Derived>
StorageIndex Eigen::PardisoImpl< Derived >::m_type
protected

Definition at line 251 of file PardisoSupport.h.

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

gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:42:18