Eigen::PardisoImpl< Derived > Class Template Reference

Inheritance diagram for Eigen::PardisoImpl< Derived >:

Collaboration diagram for Eigen::PardisoImpl< Derived >:

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

Public Member Functions
Index	cols () const
Index	rows () const
ComputationInfo	info () const
	Reports whether previous computation was successful. More...
ParameterType &	pardisoParameterArray ()
Derived &	analyzePattern (const MatrixType &matrix)
Derived &	factorize (const MatrixType &matrix)
Derived &	compute (const MatrixType &matrix)
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
Derived &	derived ()
const Derived &	derived () const
template<typename BDerived , typename XDerived >
bool	_solve (const MatrixBase< BDerived > &b, MatrixBase< XDerived > &x) const

Protected Member Functions
void	pardisoRelease ()
void	pardisoInit (int type)
void	manageErrorCode (Index error)

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

Detailed Description

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

Definition at line 99 of file PardisoSupport.h.

Member Function Documentation

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.

{
  m_size = a.rows();
  eigen_assert(m_size == a.cols());

  pardisoRelease();
  memset(m_pt, 0, sizeof(m_pt));
  m_perm.setZero(m_size);
  derived().getMatrix(a);
  
  Index error;
  error = internal::pardiso_run_selector<Index>::run(m_pt, 1, 1, m_type, 11, m_size,
                                                     m_matrix.valuePtr(), m_matrix.outerIndexPtr(), m_matrix.innerIndexPtr(),
                                                     m_perm.data(), 0, m_iparm.data(), m_msglvl, NULL, NULL);
  
  manageErrorCode(error);
  m_analysisIsOk = true;
  m_factorizationIsOk = false;
  m_initialized = true;
  return derived();
}

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.

{
  eigen_assert(m_analysisIsOk && "You must first call analyzePattern()");
  eigen_assert(m_size == a.rows() && m_size == a.cols());
  
  derived().getMatrix(a);

  Index error;  
  error = internal::pardiso_run_selector<Index>::run(m_pt, 1, 1, m_type, 22, m_size,
                                                     m_matrix.valuePtr(), m_matrix.outerIndexPtr(), m_matrix.innerIndexPtr(),
                                                     m_perm.data(), 0, m_iparm.data(), m_msglvl, NULL, NULL);
  
  manageErrorCode(error);
  m_factorizationIsOk = true;
  return derived();
}

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.

    {
      eigen_assert(m_initialized && "Decomposition is not initialized.");
      return m_info;
    }

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.

    {
      return m_iparm;
    }

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 using the current decomposition of A.

See also

compute()

Definition at line 175 of file PardisoSupport.h.

    {
      eigen_assert(m_initialized && "Pardiso solver is not initialized.");
      eigen_assert(rows()==b.rows()
                && "PardisoImpl::solve(): invalid number of rows of the right hand side matrix b");
      return internal::solve_retval<PardisoImpl, Rhs>(*this, b.derived());
    }

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 using the current decomposition of A.

See also

compute()

Definition at line 189 of file PardisoSupport.h.

    {
      eigen_assert(m_initialized && "Pardiso solver is not initialized.");
      eigen_assert(rows()==b.rows()
                && "PardisoImpl::solve(): invalid number of rows of the right hand side matrix b");
      return internal::sparse_solve_retval<PardisoImpl, Rhs>(*this, b.derived());
    }

---

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

• C:/Users/Brig/Documents/ShapeWorksStudio/src/Surfworks/Eigen/src/PardisoSupport/PardisoSupport.h