Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Types | Private Member Functions | 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 }
 
typedef Traits::Index Index
 
typedef Matrix< Index, MatrixType::RowsAtCompileTime, 1 > IntColVectorType
 
typedef Matrix< Index, 1, MatrixType::ColsAtCompileTime > IntRowVectorType
 
typedef Traits::MatrixType MatrixType
 
typedef Array< Index, 64, 1, DontAlign > ParameterType
 
typedef Traits::RealScalar RealScalar
 
typedef Traits::Scalar Scalar
 
typedef SparseMatrix< Scalar, RowMajor, Index > SparseMatrixType
 
typedef Matrix< Scalar, Dynamic, 1 > VectorType
 

Public Member Functions

template<typename BDerived , typename XDerived >
bool _solve (const MatrixBase< BDerived > &b, MatrixBase< XDerived > &x) const
 
Derived & analyzePattern (const MatrixType &matrix)
 
Index cols () const
 
Derived & compute (const MatrixType &matrix)
 
Derived & derived ()
 
const Derived & derived () const
 
Derived & factorize (const MatrixType &matrix)
 
ComputationInfo info () const
 Reports whether previous computation was successful. More...
 
 PardisoImpl ()
 
ParameterType & pardisoParameterArray ()
 
Index rows () const
 
template<typename Rhs >
const internal::solve_retval< PardisoImpl, Rhs > solve (const MatrixBase< Rhs > &b) const
 
template<typename Rhs >
const internal::sparse_solve_retval< PardisoImpl, Rhs > solve (const SparseMatrixBase< Rhs > &b) const
 
 ~PardisoImpl ()
 

Protected Member Functions

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

Protected Attributes

bool m_analysisIsOk
 
bool m_factorizationIsOk
 
ComputationInfo m_info
 
bool m_initialized
 
ParameterType m_iparm
 
SparseMatrixType m_matrix
 
Index m_msglvl
 
IntColVectorType m_perm
 
void * m_pt [64]
 
Index m_size
 
Index m_type
 

Private Types

typedef internal::pardiso_traits< Derived > Traits
 

Private Member Functions

 PardisoImpl (PardisoImpl &)
 

Detailed Description

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

Definition at line 99 of file PardisoSupport.h.

Member Typedef Documentation

◆ Index

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

Definition at line 106 of file PardisoSupport.h.

◆ IntColVectorType

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

Definition at line 110 of file PardisoSupport.h.

◆ IntRowVectorType

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

Definition at line 109 of file PardisoSupport.h.

◆ MatrixType

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

Definition at line 103 of file PardisoSupport.h.

◆ ParameterType

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

Definition at line 111 of file PardisoSupport.h.

◆ RealScalar

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

Definition at line 105 of file PardisoSupport.h.

◆ Scalar

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

Definition at line 104 of file PardisoSupport.h.

◆ SparseMatrixType

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

Definition at line 107 of file PardisoSupport.h.

◆ Traits

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

Definition at line 101 of file PardisoSupport.h.

◆ VectorType

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

Definition at line 108 of file PardisoSupport.h.

Member Enumeration Documentation

◆ anonymous enum

template<class Derived>
anonymous enum
Enumerator
ScalarIsComplex 

Definition at line 112 of file PardisoSupport.h.

Constructor & Destructor Documentation

◆ PardisoImpl() [1/2]

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

Definition at line 116 of file PardisoSupport.h.

◆ ~PardisoImpl()

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

Definition at line 124 of file PardisoSupport.h.

◆ PardisoImpl() [2/2]

template<class Derived>
Eigen::PardisoImpl< Derived >::PardisoImpl ( PardisoImpl< Derived > &  )
inlineprivate

Definition at line 281 of file PardisoSupport.h.

Member Function Documentation

◆ _solve()

template<class Base >
template<typename BDerived , typename XDerived >
bool Eigen::PardisoImpl< Base >::_solve ( const MatrixBase< BDerived > &  b,
MatrixBase< XDerived > &  x 
) const

Definition at line 350 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 308 of file PardisoSupport.h.

◆ cols()

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

Definition at line 129 of file PardisoSupport.h.

◆ compute()

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

Definition at line 285 of file PardisoSupport.h.

◆ derived() [1/2]

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

Definition at line 197 of file PardisoSupport.h.

◆ derived() [2/2]

template<class Derived>
const Derived& Eigen::PardisoImpl< Derived >::derived ( ) const
inline

Definition at line 201 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 331 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 succesful, NumericalIssue if the matrix appears to be negative.

Definition at line 137 of file PardisoSupport.h.

◆ manageErrorCode()

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

Definition at line 255 of file PardisoSupport.h.

◆ pardisoInit()

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

Definition at line 219 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 146 of file PardisoSupport.h.

◆ pardisoRelease()

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

Definition at line 210 of file PardisoSupport.h.

◆ rows()

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

Definition at line 130 of file PardisoSupport.h.

◆ solve() [1/2]

template<class Derived>
template<typename Rhs >
const internal::solve_retval<PardisoImpl, Rhs> Eigen::PardisoImpl< Derived >::solve ( const MatrixBase< Rhs > &  b) const
inline
Returns
the solution x of $ A x = b $ using the current decomposition of A.
See also
compute()

Definition at line 175 of file PardisoSupport.h.

◆ solve() [2/2]

template<class Derived>
template<typename Rhs >
const internal::sparse_solve_retval<PardisoImpl, Rhs> Eigen::PardisoImpl< Derived >::solve ( const SparseMatrixBase< Rhs > &  b) const
inline
Returns
the solution x of $ A x = b $ using the current decomposition of A.
See also
compute()

Definition at line 189 of file PardisoSupport.h.

Member Data Documentation

◆ m_analysisIsOk

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

Definition at line 273 of file PardisoSupport.h.

◆ m_factorizationIsOk

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

Definition at line 273 of file PardisoSupport.h.

◆ m_info

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

Definition at line 272 of file PardisoSupport.h.

◆ m_initialized

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

Definition at line 273 of file PardisoSupport.h.

◆ m_iparm

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

Definition at line 276 of file PardisoSupport.h.

◆ m_matrix

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

Definition at line 271 of file PardisoSupport.h.

◆ m_msglvl

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

Definition at line 274 of file PardisoSupport.h.

◆ m_perm

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

Definition at line 277 of file PardisoSupport.h.

◆ m_pt

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

Definition at line 275 of file PardisoSupport.h.

◆ m_size

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

Definition at line 278 of file PardisoSupport.h.

◆ m_type

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

Definition at line 274 of file PardisoSupport.h.

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

tuw_aruco
Author(s): Lukas Pfeifhofer
autogenerated on Mon Feb 28 2022 23:58:12