Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Friends | List of all members
Eigen::PardisoLLT Class Reference

A sparse direct Cholesky (LLT) factorization and solver based on the PARDISO library. More...

#include <PardisoSupport.h>

Public Types

enum  { UpLo = _UpLo }
 
typedef Base::RealScalar RealScalar
 
typedef Base::Scalar Scalar
 
typedef Base::StorageIndex StorageIndex
 

Public Member Functions

Derived & compute (const MatrixType &matrix)
 
 PardisoLLT ()
 
 PardisoLLT (const MatrixType &matrix)
 

Protected Types

typedef PardisoImpl< PardisoLLT< MatrixType, _UpLo > > Base
 

Protected Member Functions

void getMatrix (const MatrixType &matrix)
 
void pardisoInit (int type)
 

Protected Attributes

SparseMatrixType m_matrix
 

Friends

class PardisoImpl< PardisoLLT< MatrixType, _UpLo > >
 

Detailed Description

A sparse direct Cholesky (LLT) factorization and solver based on the PARDISO library.

This class allows to solve for A.X = B sparse linear problems via a LL^T Cholesky factorization using the Intel MKL PARDISO library. The sparse matrix A must be selfajoint and positive definite. The vectors or matrices X and B can be either dense or sparse.

By default, it runs in in-core mode. To enable PARDISO's out-of-core feature, set:

solver.pardisoParameterArray()[59] = 1;
Template Parameters
MatrixTypethe type of the sparse matrix A, it must be a SparseMatrix<>
UpLocan be any bitwise combination of Upper, Lower. The default is Upper, meaning only the upper triangular part has to be used. Upper|Lower can be used to tell both triangular parts can be used as input.

\implsparsesolverconcept

See also
Sparse solver concept, class SimplicialLLT

Definition at line 38 of file PardisoSupport.h.

Member Typedef Documentation

◆ Base

Definition at line 444 of file PardisoSupport.h.

◆ RealScalar

Definition at line 452 of file PardisoSupport.h.

◆ Scalar

Definition at line 451 of file PardisoSupport.h.

◆ StorageIndex

Definition at line 453 of file PardisoSupport.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
UpLo 

Definition at line 454 of file PardisoSupport.h.

Constructor & Destructor Documentation

◆ PardisoLLT() [1/2]

Eigen::PardisoLLT::PardisoLLT ( )
inline

Definition at line 457 of file PardisoSupport.h.

◆ PardisoLLT() [2/2]

Eigen::PardisoLLT::PardisoLLT ( const MatrixType matrix)
inlineexplicit

Definition at line 463 of file PardisoSupport.h.

Member Function Documentation

◆ compute()

Derived & Eigen::PardisoImpl< Derived >::compute

Definition at line 260 of file PardisoSupport.h.

◆ getMatrix()

void Eigen::PardisoLLT::getMatrix ( const MatrixType matrix)
inlineprotected

Definition at line 472 of file PardisoSupport.h.

◆ pardisoInit()

void Eigen::PardisoImpl< Derived >::pardisoInit
inlineprotected

Definition at line 193 of file PardisoSupport.h.

Friends And Related Function Documentation

◆ PardisoImpl< PardisoLLT< MatrixType, _UpLo > >

friend class PardisoImpl< PardisoLLT< MatrixType, _UpLo > >
friend

Definition at line 447 of file PardisoSupport.h.

Member Data Documentation

◆ m_matrix

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

Definition at line 248 of file PardisoSupport.h.


The documentation for this class was generated from the following file:
solver
BiCGSTAB< SparseMatrix< double > > solver
Definition: BiCGSTAB_simple.cpp:5


gtsam
Author(s):
autogenerated on Wed May 15 2024 15:28:47