Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index > Class Template Reference

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

#include <SparseLU_SupernodalMatrix.h>

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

Public Types
typedef _Scalar	Scalar
typedef _Index	Index
typedef Matrix< Index, Dynamic, 1 >	IndexVector
typedef Matrix< Scalar, Dynamic, 1 >	ScalarVector

Public Member Functions
	MappedSuperNodalMatrix (Index m, Index n, ScalarVector &nzval, IndexVector &nzval_colptr, IndexVector &rowind, IndexVector &rowind_colptr, IndexVector &col_to_sup, IndexVector &sup_to_col)
void	setInfos (Index m, Index n, ScalarVector &nzval, IndexVector &nzval_colptr, IndexVector &rowind, IndexVector &rowind_colptr, IndexVector &col_to_sup, IndexVector &sup_to_col)
	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.
Index	rows ()
	Number of rows.
Index	cols ()
	Number of columns.
Scalar *	valuePtr ()
	Return the array of nonzero values packed by column. More...
const Scalar *	valuePtr () const
Index *	colIndexPtr ()
	Return the pointers to the beginning of each column in valuePtr()
const Index *	colIndexPtr () const
Index *	rowIndex ()
	Return the array of compressed row indices of all supernodes.
const Index *	rowIndex () const
Index *	rowIndexPtr ()
	Return the location in rowvaluePtr() which starts each column.
const Index *	rowIndexPtr () const
Index *	colToSup ()
	Return the array of column-to-supernode mapping.
const Index *	colToSup () const
Index *	supToCol ()
	Return the array of supernode-to-column mapping.
const Index *	supToCol () const
Index	nsuper () const
	Return the number of supernodes.
template<typename Dest >
void	solveInPlace (MatrixBase< Dest > &X) const
	Solve with the supernode triangular matrix. More...

Protected Attributes
Index	m_row
Index	m_col
Index	m_nsuper
Scalar *	m_nzval
Index *	m_nzval_colptr
Index *	m_rowind
Index *	m_rowind_colptr
Index *	m_col_to_sup
Index *	m_sup_to_col

Detailed Description

template<typename _Scalar, typename _Index>
class Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index >

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

Member Function Documentation

solveInPlace()

template<typename Scalar , typename Index >

template<typename Dest >

void Eigen::internal::MappedSuperNodalMatrix< Scalar, Index >::solveInPlace

(

MatrixBase< Dest > &

X

)

const

Solve with the supernode triangular matrix.

valuePtr()

template<typename _Scalar, typename _Index>

Scalar* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index >::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:

• vendor/eigen/Eigen/src/SparseLU/SparseLU_SupernodalMatrix.h