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 Matrix< StorageIndex, Dynamic, 1 >	IndexVector

typedef _Scalar	Scalar

typedef Matrix< Scalar, Dynamic, 1 >	ScalarVector

typedef _StorageIndex	StorageIndex

Public Member Functions
StorageIndex *	colIndexPtr ()

const StorageIndex *	colIndexPtr () const

Index	cols ()

StorageIndex *	colToSup ()

const StorageIndex *	colToSup () const

	MappedSuperNodalMatrix ()

	MappedSuperNodalMatrix (Index m, Index n, ScalarVector &nzval, IndexVector &nzval_colptr, IndexVector &rowind, IndexVector &rowind_colptr, IndexVector &col_to_sup, IndexVector &sup_to_col)

Index	nsuper () const

StorageIndex *	rowIndex ()

const StorageIndex *	rowIndex () const

StorageIndex *	rowIndexPtr ()

const StorageIndex *	rowIndexPtr () const

Index	rows ()

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. More...

StorageIndex *	supToCol ()

const StorageIndex *	supToCol () const

Scalar *	valuePtr ()

const Scalar *	valuePtr () const

	~MappedSuperNodalMatrix ()

Protected Attributes
Index	m_col

StorageIndex *	m_col_to_sup

Index	m_nsuper

Scalar *	m_nzval

StorageIndex *	m_nzval_colptr

Index	m_row

StorageIndex *	m_rowind

StorageIndex *	m_rowind_colptr

StorageIndex *	m_sup_to_col

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

Definition at line 33 of file SparseLU_SupernodalMatrix.h.

Member Typedef Documentation

template<typename _Scalar, typename _StorageIndex>

typedef Matrix<StorageIndex,Dynamic,1> Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::IndexVector

Definition at line 38 of file SparseLU_SupernodalMatrix.h.

template<typename _Scalar, typename _StorageIndex>

typedef _Scalar Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::Scalar

Definition at line 36 of file SparseLU_SupernodalMatrix.h.

template<typename _Scalar, typename _StorageIndex>

typedef Matrix<Scalar,Dynamic,1> Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::ScalarVector

Definition at line 39 of file SparseLU_SupernodalMatrix.h.

template<typename _Scalar, typename _StorageIndex>

typedef _StorageIndex Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::StorageIndex

Definition at line 37 of file SparseLU_SupernodalMatrix.h.

Constructor & Destructor Documentation

template<typename _Scalar, typename _StorageIndex>

Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::MappedSuperNodalMatrix ( )

inline

Definition at line 41 of file SparseLU_SupernodalMatrix.h.

template<typename _Scalar, typename _StorageIndex>

Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::MappedSuperNodalMatrix	(	Index	m,
		Index	n,
		ScalarVector &	nzval,
		IndexVector &	nzval_colptr,
		IndexVector &	rowind,
		IndexVector &	rowind_colptr,
		IndexVector &	col_to_sup,
		IndexVector &	sup_to_col
	)

inline

Definition at line 45 of file SparseLU_SupernodalMatrix.h.

template<typename _Scalar, typename _StorageIndex>

Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::~MappedSuperNodalMatrix ( )

inline

Definition at line 51 of file SparseLU_SupernodalMatrix.h.

Member Function Documentation

template<typename _Scalar, typename _StorageIndex>

StorageIndex* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::colIndexPtr ( )

inline

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

Definition at line 99 of file SparseLU_SupernodalMatrix.h.

template<typename _Scalar, typename _StorageIndex>

const StorageIndex* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::colIndexPtr ( ) const

inline

Definition at line 104 of file SparseLU_SupernodalMatrix.h.

template<typename _Scalar, typename _StorageIndex>

Index Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::cols ( void )

inline

Number of columns

Definition at line 83 of file SparseLU_SupernodalMatrix.h.

template<typename _Scalar, typename _StorageIndex>

StorageIndex* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::colToSup ( )

inline

Return the array of column-to-supernode mapping

Definition at line 132 of file SparseLU_SupernodalMatrix.h.

template<typename _Scalar, typename _StorageIndex>

const StorageIndex* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::colToSup ( ) const

inline

Definition at line 134 of file SparseLU_SupernodalMatrix.h.

template<typename _Scalar, typename _StorageIndex>

Index Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::nsuper ( ) const

inline

Return the number of supernodes

Definition at line 151 of file SparseLU_SupernodalMatrix.h.

template<typename _Scalar, typename _StorageIndex>

StorageIndex* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::rowIndex ( )

inline

Return the array of compressed row indices of all supernodes

Definition at line 112 of file SparseLU_SupernodalMatrix.h.

template<typename _Scalar, typename _StorageIndex>

const StorageIndex* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::rowIndex ( ) const

inline

Definition at line 114 of file SparseLU_SupernodalMatrix.h.

template<typename _Scalar, typename _StorageIndex>

StorageIndex* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::rowIndexPtr ( )

inline

Return the location in rowvaluePtr() which starts each column

Definition at line 122 of file SparseLU_SupernodalMatrix.h.

template<typename _Scalar, typename _StorageIndex>

const StorageIndex* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::rowIndexPtr ( ) const

inline

Definition at line 124 of file SparseLU_SupernodalMatrix.h.

template<typename _Scalar, typename _StorageIndex>

Index Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::rows ( void )

inline

Number of rows

Definition at line 78 of file SparseLU_SupernodalMatrix.h.

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.

Definition at line 61 of file SparseLU_SupernodalMatrix.h.

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.

Definition at line 234 of file SparseLU_SupernodalMatrix.h.

template<typename _Scalar, typename _StorageIndex>

StorageIndex* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::supToCol ( )

inline

Return the array of supernode-to-column mapping

Definition at line 141 of file SparseLU_SupernodalMatrix.h.

template<typename _Scalar, typename _StorageIndex>

const StorageIndex* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::supToCol ( ) const

inline

Definition at line 143 of file SparseLU_SupernodalMatrix.h.

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

Definition at line 90 of file SparseLU_SupernodalMatrix.h.

template<typename _Scalar, typename _StorageIndex>

const Scalar* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::valuePtr ( ) const

inline

Definition at line 92 of file SparseLU_SupernodalMatrix.h.

Member Data Documentation

template<typename _Scalar, typename _StorageIndex>

Index Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::m_col

protected

Definition at line 165 of file SparseLU_SupernodalMatrix.h.

template<typename _Scalar, typename _StorageIndex>

StorageIndex* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::m_col_to_sup

protected

Definition at line 171 of file SparseLU_SupernodalMatrix.h.

template<typename _Scalar, typename _StorageIndex>

Index Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::m_nsuper

protected

Definition at line 166 of file SparseLU_SupernodalMatrix.h.

template<typename _Scalar, typename _StorageIndex>

Scalar* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::m_nzval

protected

Definition at line 167 of file SparseLU_SupernodalMatrix.h.

template<typename _Scalar, typename _StorageIndex>

StorageIndex* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::m_nzval_colptr

protected

Definition at line 168 of file SparseLU_SupernodalMatrix.h.

template<typename _Scalar, typename _StorageIndex>

Index Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::m_row

protected

Definition at line 164 of file SparseLU_SupernodalMatrix.h.

template<typename _Scalar, typename _StorageIndex>

StorageIndex* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::m_rowind

protected

Definition at line 169 of file SparseLU_SupernodalMatrix.h.

template<typename _Scalar, typename _StorageIndex>

StorageIndex* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::m_rowind_colptr

protected

Definition at line 170 of file SparseLU_SupernodalMatrix.h.

template<typename _Scalar, typename _StorageIndex>

StorageIndex* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::m_sup_to_col

protected

Definition at line 172 of file SparseLU_SupernodalMatrix.h.

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

SparseLU_SupernodalMatrix.h

Classes

Public Types

Public Member Functions

Protected Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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