Eigen::internal::MappedSuperNodalMatrix< Scalar_, StorageIndex_ > Class Template Reference

#include <Eigen/src/SparseLU/SparseLU_SupernodalMatrix.h>

Detailed Description

template<typename Scalar_, typename StorageIndex_>
class Eigen::internal::MappedSuperNodalMatrix< Scalar_, StorageIndex_ >

a class to manipulate the L supernodal factor from the SparseLU factorization

This class contain the data to easily store and manipulate the supernodes during the factorization and solution phase of Sparse LU. Only the lower triangular matrix has supernodes.

NOTE : This class corresponds to the SCformat structure in SuperLU

Classes
class	InnerIterator
	InnerIterator class to iterate over nonzero values of the current column in the supernodal matrix L. More...

Public Member Functions
StorageIndex *	colIndexPtr ()
Index	cols () const
StorageIndex *	colToSup ()
Index	nsuper () const
StorageIndex *	rowIndex ()
StorageIndex *	rowIndexPtr ()
Index	rows () const
void	setInfos (Index m, Index n, ScalarVector &nzval, IndexVector &nzval_colptr, IndexVector &rowind, IndexVector &rowind_colptr, IndexVector &col_to_sup, IndexVector &sup_to_col)
template<typename Dest>
void	solveInPlace (MatrixBase< Dest > &X) const
	Solve with the supernode triangular matrix.
StorageIndex *	supToCol ()
Scalar *	valuePtr ()

Member Function Documentation

colIndexPtr()

template<typename Scalar_, typename StorageIndex_>

StorageIndex * Eigen::internal::MappedSuperNodalMatrix< Scalar_, StorageIndex_ >::colIndexPtr ( )

inline

Return the pointers to the beginning of each column in valuePtr()

cols()

template<typename Scalar_, typename StorageIndex_>

Index Eigen::internal::MappedSuperNodalMatrix< Scalar_, StorageIndex_ >::cols ( ) const

inline

Number of columns

colToSup()

template<typename Scalar_, typename StorageIndex_>

StorageIndex * Eigen::internal::MappedSuperNodalMatrix< Scalar_, StorageIndex_ >::colToSup ( )

inline

Return the array of column-to-supernode mapping

nsuper()

template<typename Scalar_, typename StorageIndex_>

Index Eigen::internal::MappedSuperNodalMatrix< Scalar_, StorageIndex_ >::nsuper ( ) const

inline

Return the number of supernodes

rowIndex()

template<typename Scalar_, typename StorageIndex_>

StorageIndex * Eigen::internal::MappedSuperNodalMatrix< Scalar_, StorageIndex_ >::rowIndex ( )

inline

Return the array of compressed row indices of all supernodes

rowIndexPtr()

template<typename Scalar_, typename StorageIndex_>

StorageIndex * Eigen::internal::MappedSuperNodalMatrix< Scalar_, StorageIndex_ >::rowIndexPtr ( )

inline

Return the location in rowvaluePtr() which starts each column

rows()

template<typename Scalar_, typename StorageIndex_>

Index Eigen::internal::MappedSuperNodalMatrix< Scalar_, StorageIndex_ >::rows ( ) const

inline

Number of rows

setInfos()

template<typename Scalar_, typename StorageIndex_>

void Eigen::internal::MappedSuperNodalMatrix< Scalar_, StorageIndex_ >::setInfos ( Index m, Index n, ScalarVector & nzval, IndexVector & nzval_colptr, IndexVector & rowind, IndexVector & rowind_colptr, IndexVector & col_to_sup, IndexVector & sup_to_col )

inline

Set appropriate pointers for the lower triangular supernodal matrix These infos are available at the end of the numerical factorization FIXME This class will be modified such that it can be use in the course of the factorization.

supToCol()

template<typename Scalar_, typename StorageIndex_>

StorageIndex * Eigen::internal::MappedSuperNodalMatrix< Scalar_, StorageIndex_ >::supToCol ( )

inline

Return the array of supernode-to-column mapping

valuePtr()

template<typename Scalar_, typename StorageIndex_>

Scalar * Eigen::internal::MappedSuperNodalMatrix< Scalar_, StorageIndex_ >::valuePtr ( )

inline

Return the array of nonzero values packed by column

The size is nnz

---

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

• /builds/libeigen/eigen/Eigen/src/SparseLU/SparseLU_SupernodalMatrix.h