The base class for the direct and incomplete LU factorization of SuperLU. More...

Inheritance diagram for Eigen::SuperLUBase< MatrixType_, Derived >:

Public Types
enum	{ ColsAtCompileTime , MaxColsAtCompileTime }

typedef Matrix< int, MatrixType::RowsAtCompileTime, 1 >	IntColVectorType

typedef Matrix< int, 1, MatrixType::ColsAtCompileTime >	IntRowVectorType

typedef SparseMatrix< Scalar >	LUMatrixType

typedef MatrixType_	MatrixType

typedef Map< PermutationMatrix< Dynamic, Dynamic, int > >	PermutationMap

typedef MatrixType::RealScalar	RealScalar

typedef MatrixType::Scalar	Scalar

typedef MatrixType::StorageIndex	StorageIndex

typedef Matrix< Scalar, Dynamic, 1 >	Vector

Public Member Functions
void	analyzePattern (const MatrixType &)

Index	cols () const

void	compute (const MatrixType &matrix)

template<typename Stream >
void	dumpMemory (Stream &)

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

superlu_options_t &	options ()

Index	rows () const

	SuperLUBase ()

	~SuperLUBase ()

Public Member Functions inherited from Eigen::SparseSolverBase< Derived >
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 (SparseSolverBase &&other)

	~SparseSolverBase ()

Protected Types
typedef SparseSolverBase< Derived >	Base

Protected Member Functions
void	clearFactors ()

Derived &	derived ()

const Derived &	derived () const

void	extractData () const

void	init ()

void	initFactorization (const MatrixType &a)

Protected Attributes
int	m_analysisIsOk

bool	m_extractedDataAreDirty

int	m_factorizationIsOk

ComputationInfo	m_info

bool	m_isInitialized

LUMatrixType	m_l

LUMatrixType	m_matrix

IntColVectorType	m_p

IntRowVectorType	m_q

SluMatrix	m_sluA

SluMatrix	m_sluB

Matrix< RealScalar, Dynamic, 1 >	m_sluBerr

Matrix< RealScalar, Dynamic, 1 >	m_sluCscale

char	m_sluEqued

std::vector< int >	m_sluEtree

Matrix< RealScalar, Dynamic, 1 >	m_sluFerr

SuperMatrix	m_sluL

superlu_options_t	m_sluOptions

Matrix< RealScalar, Dynamic, 1 >	m_sluRscale

SuperLUStat_t	m_sluStat

SuperMatrix	m_sluU

SluMatrix	m_sluX

LUMatrixType	m_u

Protected Attributes inherited from Eigen::SparseSolverBase< Derived >
bool	m_isInitialized

Private Member Functions
	SuperLUBase (SuperLUBase &)

Detailed Description

template<typename MatrixType_, typename Derived>
class Eigen::SuperLUBase< MatrixType_, Derived >

The base class for the direct and incomplete LU factorization of SuperLU.

Definition at line 319 of file SuperLUSupport.h.

Member Typedef Documentation

◆ Base

template<typename MatrixType_ , typename Derived >

typedef SparseSolverBase<Derived> Eigen::SuperLUBase< MatrixType_, Derived >::Base

protected

Definition at line 322 of file SuperLUSupport.h.

◆ IntColVectorType

template<typename MatrixType_ , typename Derived >

typedef Matrix<int, MatrixType::RowsAtCompileTime, 1> Eigen::SuperLUBase< MatrixType_, Derived >::IntColVectorType

Definition at line 332 of file SuperLUSupport.h.

◆ IntRowVectorType

template<typename MatrixType_ , typename Derived >

typedef Matrix<int, 1, MatrixType::ColsAtCompileTime> Eigen::SuperLUBase< MatrixType_, Derived >::IntRowVectorType

Definition at line 331 of file SuperLUSupport.h.

◆ LUMatrixType

template<typename MatrixType_ , typename Derived >

typedef SparseMatrix<Scalar> Eigen::SuperLUBase< MatrixType_, Derived >::LUMatrixType

Definition at line 334 of file SuperLUSupport.h.

◆ MatrixType

template<typename MatrixType_ , typename Derived >

typedef MatrixType_ Eigen::SuperLUBase< MatrixType_, Derived >::MatrixType

Definition at line 326 of file SuperLUSupport.h.

◆ PermutationMap

template<typename MatrixType_ , typename Derived >

typedef Map<PermutationMatrix<Dynamic,Dynamic,int> > Eigen::SuperLUBase< MatrixType_, Derived >::PermutationMap

Definition at line 333 of file SuperLUSupport.h.

◆ RealScalar

template<typename MatrixType_ , typename Derived >

typedef MatrixType::RealScalar Eigen::SuperLUBase< MatrixType_, Derived >::RealScalar

Definition at line 328 of file SuperLUSupport.h.

◆ Scalar

template<typename MatrixType_ , typename Derived >

typedef MatrixType::Scalar Eigen::SuperLUBase< MatrixType_, Derived >::Scalar

Definition at line 327 of file SuperLUSupport.h.

◆ StorageIndex

template<typename MatrixType_ , typename Derived >

typedef MatrixType::StorageIndex Eigen::SuperLUBase< MatrixType_, Derived >::StorageIndex

Definition at line 329 of file SuperLUSupport.h.

◆ Vector

template<typename MatrixType_ , typename Derived >

typedef Matrix<Scalar,Dynamic,1> Eigen::SuperLUBase< MatrixType_, Derived >::Vector

Definition at line 330 of file SuperLUSupport.h.

Member Enumeration Documentation

◆ anonymous enum

template<typename MatrixType_ , typename Derived >

anonymous enum

Enumerator
ColsAtCompileTime
MaxColsAtCompileTime

Definition at line 335 of file SuperLUSupport.h.

          {
       ColsAtCompileTime = MatrixType::ColsAtCompileTime,
       MaxColsAtCompileTime = MatrixType::MaxColsAtCompileTime
     };

Constructor & Destructor Documentation

◆ SuperLUBase() [1/2]

template<typename MatrixType_ , typename Derived >

Eigen::SuperLUBase< MatrixType_, Derived >::SuperLUBase ( )

inline

Definition at line 342 of file SuperLUSupport.h.

342 {}

◆ ~SuperLUBase()

template<typename MatrixType_ , typename Derived >

Eigen::SuperLUBase< MatrixType_, Derived >::~SuperLUBase ( )

inline

Definition at line 344 of file SuperLUSupport.h.

     {
       clearFactors();
     }

◆ SuperLUBase() [2/2]

template<typename MatrixType_ , typename Derived >

Eigen::SuperLUBase< MatrixType_, Derived >::SuperLUBase ( SuperLUBase< MatrixType_, Derived > & )

inlineprivate

Definition at line 469 of file SuperLUSupport.h.

469 { }

Member Function Documentation

◆ analyzePattern()

template<typename MatrixType_ , typename Derived >

void Eigen::SuperLUBase< MatrixType_, Derived >::analyzePattern ( const MatrixType & )

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

Definition at line 379 of file SuperLUSupport.h.

     {
       m_isInitialized = true;
       m_info = Success;
       m_analysisIsOk = true;
       m_factorizationIsOk = false;
     }

◆ clearFactors()

template<typename MatrixType_ , typename Derived >

void Eigen::SuperLUBase< MatrixType_, Derived >::clearFactors ( )

inlineprotected

Definition at line 432 of file SuperLUSupport.h.

     {
       if(m_sluL.Store)
         Destroy_SuperNode_Matrix(&m_sluL);
       if(m_sluU.Store)
         Destroy_CompCol_Matrix(&m_sluU);
  
       m_sluL.Store = 0;
       m_sluU.Store = 0;
  
       memset(&m_sluL,0,sizeof m_sluL);
       memset(&m_sluU,0,sizeof m_sluU);
     }

◆ cols()

template<typename MatrixType_ , typename Derived >

Index Eigen::SuperLUBase< MatrixType_, Derived >::cols ( void ) const

inline

Definition at line 350 of file SuperLUSupport.h.

350 { return m_matrix.cols(); }

Eigen::SparseMatrix::cols

Index cols() const

Definition: SparseMatrix.h:167

Eigen::SuperLUBase::m_matrix

LUMatrixType m_matrix

Definition: SuperLUSupport.h:452

◆ compute()

template<typename MatrixType_ , typename Derived >

void Eigen::SuperLUBase< MatrixType_, Derived >::compute ( const MatrixType & matrix )

inline

Computes the sparse Cholesky decomposition of matrix

Definition at line 367 of file SuperLUSupport.h.

     {
       derived().analyzePattern(matrix);
       derived().factorize(matrix);
     }

◆ derived() [1/2]

template<typename MatrixType_ , typename Derived >

Derived& Eigen::SparseSolverBase< Derived >::derived

inlineprotected

Definition at line 83 of file SparseSolverBase.h.

83 { return *static_cast<Derived*>(this); }

◆ derived() [2/2]

template<typename MatrixType_ , typename Derived >

const Derived& Eigen::SparseSolverBase< Derived >::derived

inlineprotected

Definition at line 84 of file SparseSolverBase.h.

84 { return *static_cast<const Derived*>(this); }

◆ dumpMemory()

template<typename MatrixType_ , typename Derived >

template<typename Stream >

void Eigen::SuperLUBase< MatrixType_, Derived >::dumpMemory ( Stream & )

inline

Definition at line 388 of file SuperLUSupport.h.

389 {}

◆ extractData()

template<typename MatrixType , typename Derived >

void Eigen::SuperLUBase< MatrixType, Derived >::extractData

protected

Definition at line 708 of file SuperLUSupport.h.

 {
   eigen_assert(m_factorizationIsOk && "The decomposition is not in a valid state for extracting factors, you must first call either compute() or analyzePattern()/factorize()");
   if (m_extractedDataAreDirty)
   {
     int         upper;
     int         fsupc, istart, nsupr;
     int         lastl = 0, lastu = 0;
     SCformat    *Lstore = static_cast<SCformat*>(m_sluL.Store);
     NCformat    *Ustore = static_cast<NCformat*>(m_sluU.Store);
     Scalar      *SNptr;
  
     const Index size = m_matrix.rows();
     m_l.resize(size,size);
     m_l.resizeNonZeros(Lstore->nnz);
     m_u.resize(size,size);
     m_u.resizeNonZeros(Ustore->nnz);
  
     int* Lcol = m_l.outerIndexPtr();
     int* Lrow = m_l.innerIndexPtr();
     Scalar* Lval = m_l.valuePtr();
  
     int* Ucol = m_u.outerIndexPtr();
     int* Urow = m_u.innerIndexPtr();
     Scalar* Uval = m_u.valuePtr();
  
     Ucol[0] = 0;
     Ucol[0] = 0;
  
     /* for each supernode */
     for (int k = 0; k <= Lstore->nsuper; ++k)
     {
       fsupc   = L_FST_SUPC(k);
       istart  = L_SUB_START(fsupc);
       nsupr   = L_SUB_START(fsupc+1) - istart;
       upper   = 1;
  
       /* for each column in the supernode */
       for (int j = fsupc; j < L_FST_SUPC(k+1); ++j)
       {
         SNptr = &((Scalar*)Lstore->nzval)[L_NZ_START(j)];
  
         /* Extract U */
         for (int i = U_NZ_START(j); i < U_NZ_START(j+1); ++i)
         {
           Uval[lastu] = ((Scalar*)Ustore->nzval)[i];
           /* Matlab doesn't like explicit zero. */
           if (Uval[lastu] != 0.0)
             Urow[lastu++] = U_SUB(i);
         }
         for (int i = 0; i < upper; ++i)
         {
           /* upper triangle in the supernode */
           Uval[lastu] = SNptr[i];
           /* Matlab doesn't like explicit zero. */
           if (Uval[lastu] != 0.0)
             Urow[lastu++] = L_SUB(istart+i);
         }
         Ucol[j+1] = lastu;
  
         /* Extract L */
         Lval[lastl] = 1.0; /* unit diagonal */
         Lrow[lastl++] = L_SUB(istart + upper - 1);
         for (int i = upper; i < nsupr; ++i)
         {
           Lval[lastl] = SNptr[i];
           /* Matlab doesn't like explicit zero. */
           if (Lval[lastl] != 0.0)
             Lrow[lastl++] = L_SUB(istart+i);
         }
         Lcol[j+1] = lastl;
  
         ++upper;
       } /* for j ... */
  
     } /* for k ... */
  
     // squeeze the matrices :
     m_l.resizeNonZeros(lastl);
     m_u.resizeNonZeros(lastu);
  
     m_extractedDataAreDirty = false;
   }
 }

◆ info()

template<typename MatrixType_ , typename Derived >

ComputationInfo Eigen::SuperLUBase< MatrixType_, 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 360 of file SuperLUSupport.h.

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

◆ init()

template<typename MatrixType_ , typename Derived >

void Eigen::SuperLUBase< MatrixType_, Derived >::init ( )

inlineprotected

Definition at line 422 of file SuperLUSupport.h.

     {
       m_info = InvalidInput;
       m_isInitialized = false;
       m_sluL.Store = 0;
       m_sluU.Store = 0;
     }

◆ initFactorization()

template<typename MatrixType_ , typename Derived >

void Eigen::SuperLUBase< MatrixType_, Derived >::initFactorization ( const MatrixType & a )

inlineprotected

Definition at line 393 of file SuperLUSupport.h.

     {
       set_default_options(&this->m_sluOptions);
       
       const Index size = a.rows();
       m_matrix = a;
  
       m_sluA = internal::asSluMatrix(m_matrix);
       clearFactors();
  
       m_p.resize(size);
       m_q.resize(size);
       m_sluRscale.resize(size);
       m_sluCscale.resize(size);
       m_sluEtree.resize(size);
  
       // set empty B and X
       m_sluB.setStorageType(SLU_DN);
       m_sluB.setScalarType<Scalar>();
       m_sluB.Mtype          = SLU_GE;
       m_sluB.storage.values = 0;
       m_sluB.nrow           = 0;
       m_sluB.ncol           = 0;
       m_sluB.storage.lda    = internal::convert_index<int>(size);
       m_sluX                = m_sluB;
       
       m_extractedDataAreDirty = true;
     }

◆ options()

template<typename MatrixType_ , typename Derived >

superlu_options_t& Eigen::SuperLUBase< MatrixType_, Derived >::options ( )

inline

Returns: a reference to the Super LU option object to configure the Super LU algorithms.

Definition at line 353 of file SuperLUSupport.h.

353 { return m_sluOptions; }

◆ rows()

template<typename MatrixType_ , typename Derived >

Index Eigen::SuperLUBase< MatrixType_, Derived >::rows ( void ) const

inline

Definition at line 349 of file SuperLUSupport.h.

349 { return m_matrix.rows(); }

Member Data Documentation

◆ m_analysisIsOk

template<typename MatrixType_ , typename Derived >

int Eigen::SuperLUBase< MatrixType_, Derived >::m_analysisIsOk

protected

Definition at line 465 of file SuperLUSupport.h.

◆ m_extractedDataAreDirty

template<typename MatrixType_ , typename Derived >

bool Eigen::SuperLUBase< MatrixType_, Derived >::m_extractedDataAreDirty

mutableprotected

Definition at line 466 of file SuperLUSupport.h.

◆ m_factorizationIsOk

template<typename MatrixType_ , typename Derived >

int Eigen::SuperLUBase< MatrixType_, Derived >::m_factorizationIsOk

protected

Definition at line 464 of file SuperLUSupport.h.

◆ m_info

template<typename MatrixType_ , typename Derived >

ComputationInfo Eigen::SuperLUBase< MatrixType_, Derived >::m_info

mutableprotected

Definition at line 463 of file SuperLUSupport.h.

◆ m_isInitialized

template<typename MatrixType_ , typename Derived >

bool Eigen::SparseSolverBase< Derived >::m_isInitialized

mutableprotected

Definition at line 123 of file SparseSolverBase.h.

◆ m_l

template<typename MatrixType_ , typename Derived >

LUMatrixType Eigen::SuperLUBase< MatrixType_, Derived >::m_l

mutableprotected

Definition at line 447 of file SuperLUSupport.h.

◆ m_matrix

template<typename MatrixType_ , typename Derived >

LUMatrixType Eigen::SuperLUBase< MatrixType_, Derived >::m_matrix

mutableprotected

Definition at line 452 of file SuperLUSupport.h.

◆ m_p

template<typename MatrixType_ , typename Derived >

IntColVectorType Eigen::SuperLUBase< MatrixType_, Derived >::m_p

mutableprotected

Definition at line 449 of file SuperLUSupport.h.

◆ m_q

template<typename MatrixType_ , typename Derived >

IntRowVectorType Eigen::SuperLUBase< MatrixType_, Derived >::m_q

mutableprotected

Definition at line 450 of file SuperLUSupport.h.

◆ m_sluA

template<typename MatrixType_ , typename Derived >

SluMatrix Eigen::SuperLUBase< MatrixType_, Derived >::m_sluA

mutableprotected

Definition at line 453 of file SuperLUSupport.h.

◆ m_sluB

template<typename MatrixType_ , typename Derived >

SluMatrix Eigen::SuperLUBase< MatrixType_, Derived >::m_sluB

mutableprotected

Definition at line 455 of file SuperLUSupport.h.

◆ m_sluBerr

template<typename MatrixType_ , typename Derived >

Matrix<RealScalar,Dynamic,1> Eigen::SuperLUBase< MatrixType_, Derived >::m_sluBerr

protected

Definition at line 460 of file SuperLUSupport.h.

◆ m_sluCscale

template<typename MatrixType_ , typename Derived >

Matrix<RealScalar,Dynamic,1> Eigen::SuperLUBase< MatrixType_, Derived >::m_sluCscale

protected

Definition at line 459 of file SuperLUSupport.h.

◆ m_sluEqued

template<typename MatrixType_ , typename Derived >

char Eigen::SuperLUBase< MatrixType_, Derived >::m_sluEqued

mutableprotected

Definition at line 461 of file SuperLUSupport.h.

◆ m_sluEtree

template<typename MatrixType_ , typename Derived >

std::vector<int> Eigen::SuperLUBase< MatrixType_, Derived >::m_sluEtree

mutableprotected

Definition at line 458 of file SuperLUSupport.h.

◆ m_sluFerr

template<typename MatrixType_ , typename Derived >

Matrix<RealScalar,Dynamic,1> Eigen::SuperLUBase< MatrixType_, Derived >::m_sluFerr

mutableprotected

Definition at line 460 of file SuperLUSupport.h.

◆ m_sluL

template<typename MatrixType_ , typename Derived >

SuperMatrix Eigen::SuperLUBase< MatrixType_, Derived >::m_sluL

mutableprotected

Definition at line 454 of file SuperLUSupport.h.

◆ m_sluOptions

template<typename MatrixType_ , typename Derived >

superlu_options_t Eigen::SuperLUBase< MatrixType_, Derived >::m_sluOptions

mutableprotected

Definition at line 457 of file SuperLUSupport.h.

◆ m_sluRscale

template<typename MatrixType_ , typename Derived >

Matrix<RealScalar,Dynamic,1> Eigen::SuperLUBase< MatrixType_, Derived >::m_sluRscale

mutableprotected

Definition at line 459 of file SuperLUSupport.h.

◆ m_sluStat

template<typename MatrixType_ , typename Derived >

SuperLUStat_t Eigen::SuperLUBase< MatrixType_, Derived >::m_sluStat

mutableprotected

Definition at line 456 of file SuperLUSupport.h.

◆ m_sluU

template<typename MatrixType_ , typename Derived >

SuperMatrix Eigen::SuperLUBase< MatrixType_, Derived >::m_sluU

protected

Definition at line 454 of file SuperLUSupport.h.

◆ m_sluX

template<typename MatrixType_ , typename Derived >

SluMatrix Eigen::SuperLUBase< MatrixType_, Derived >::m_sluX

protected

Definition at line 455 of file SuperLUSupport.h.

◆ m_u

template<typename MatrixType_ , typename Derived >

LUMatrixType Eigen::SuperLUBase< MatrixType_, Derived >::m_u

mutableprotected

Definition at line 448 of file SuperLUSupport.h.

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

SuperLUSupport.h

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

template<typename MatrixType_, typename Derived> class Eigen::SuperLUBase< MatrixType_, Derived >

Member Typedef Documentation

◆ Base

◆ IntColVectorType

◆ IntRowVectorType

◆ LUMatrixType

◆ MatrixType

◆ PermutationMap

◆ RealScalar

◆ Scalar

◆ StorageIndex

◆ Vector

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ SuperLUBase() [1/2]

◆ ~SuperLUBase()

◆ SuperLUBase() [2/2]

Member Function Documentation

◆ analyzePattern()

◆ clearFactors()

◆ cols()

◆ compute()

◆ derived() [1/2]

◆ derived() [2/2]

◆ dumpMemory()

◆ extractData()

◆ info()

◆ init()

◆ initFactorization()

◆ options()

◆ rows()

Member Data Documentation

◆ m_analysisIsOk

◆ m_extractedDataAreDirty

◆ m_factorizationIsOk

◆ m_info

◆ m_isInitialized

◆ m_l

◆ m_matrix

◆ m_p

◆ m_q

◆ m_sluA

◆ m_sluB

◆ m_sluBerr

◆ m_sluCscale

◆ m_sluEqued

◆ m_sluEtree

◆ m_sluFerr

◆ m_sluL

◆ m_sluOptions

◆ m_sluRscale

◆ m_sluStat

◆ m_sluU

◆ m_sluX

◆ m_u

template<typename MatrixType_, typename Derived>
class Eigen::SuperLUBase< MatrixType_, Derived >