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

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

Inheritance diagram for Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >:

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 _StorageIndex	StorageIndex

typedef Matrix< StorageIndex, Dynamic, 1 >	IndexVector

typedef Matrix< Scalar, Dynamic, 1 >	ScalarVector

Public Member Functions
	MappedSuperNodalMatrix ()

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

	~MappedSuperNodalMatrix ()

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

Index	rows ()

Index	cols ()

Scalar *	valuePtr ()

const Scalar *	valuePtr () const

StorageIndex *	colIndexPtr ()

const StorageIndex *	colIndexPtr () const

StorageIndex *	rowIndex ()

const StorageIndex *	rowIndex () const

StorageIndex *	rowIndexPtr ()

const StorageIndex *	rowIndexPtr () const

StorageIndex *	colToSup ()

const StorageIndex *	colToSup () const

StorageIndex *	supToCol ()

const StorageIndex *	supToCol () const

Index	nsuper () const

template<typename Dest >
void	solveInPlace (MatrixBase< Dest > &X) const
	Solve with the supernode triangular matrix.

Protected Attributes
Index	m_row

Index	m_col

Index	m_nsuper

Scalar *	m_nzval

StorageIndex *	m_nzval_colptr

StorageIndex *	m_rowind

StorageIndex *	m_rowind_colptr

StorageIndex *	m_col_to_sup

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

Member Typedef Documentation

◆ IndexVector

template<typename _Scalar , typename _StorageIndex >

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

◆ Scalar

template<typename _Scalar , typename _StorageIndex >

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

◆ ScalarVector

template<typename _Scalar , typename _StorageIndex >

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

◆ StorageIndex

template<typename _Scalar , typename _StorageIndex >

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

Constructor & Destructor Documentation

◆ MappedSuperNodalMatrix() [1/2]

template<typename _Scalar , typename _StorageIndex >

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

inline

    {
      
    }

◆ MappedSuperNodalMatrix() [2/2]

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

    {
      setInfos(m, n, nzval, nzval_colptr, rowind, rowind_colptr, col_to_sup, sup_to_col);
    }

References Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::setInfos().

Here is the call graph for this function:

◆ ~MappedSuperNodalMatrix()

template<typename _Scalar , typename _StorageIndex >

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

inline

    {
      
    }

Member Function Documentation

◆ colIndexPtr() [1/2]

template<typename _Scalar , typename _StorageIndex >

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

inline

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

    {
      return m_nzval_colptr; 
    }

References Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::m_nzval_colptr.

◆ colIndexPtr() [2/2]

template<typename _Scalar , typename _StorageIndex >

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

inline

    {
      return m_nzval_colptr; 
    }

References Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::m_nzval_colptr.

◆ cols()

template<typename _Scalar , typename _StorageIndex >

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

inline

Number of columns

83{ return m_col; }

Eigen::internal::MappedSuperNodalMatrix::m_col

Index m_col

Definition SparseLU_SupernodalMatrix.h:165

References Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::m_col.

◆ colToSup() [1/2]

template<typename _Scalar , typename _StorageIndex >

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

inline

Return the array of column-to-supernode mapping

132{ return m_col_to_sup; }

Eigen::internal::MappedSuperNodalMatrix::m_col_to_sup

StorageIndex * m_col_to_sup

Definition SparseLU_SupernodalMatrix.h:171

References Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::m_col_to_sup.

◆ colToSup() [2/2]

template<typename _Scalar , typename _StorageIndex >

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

inline

    {
      return m_col_to_sup;       
    }

References Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::m_col_to_sup.

◆ nsuper()

template<typename _Scalar , typename _StorageIndex >

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

inline

Return the number of supernodes

    {
      return m_nsuper; 
    }

References Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::m_nsuper.

◆ rowIndex() [1/2]

template<typename _Scalar , typename _StorageIndex >

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

inline

Return the array of compressed row indices of all supernodes

112{ return m_rowind; }

Eigen::internal::MappedSuperNodalMatrix::m_rowind

StorageIndex * m_rowind

Definition SparseLU_SupernodalMatrix.h:169

References Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::m_rowind.

◆ rowIndex() [2/2]

template<typename _Scalar , typename _StorageIndex >

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

inline

    {
      return m_rowind; 
    }

References Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::m_rowind.

◆ rowIndexPtr() [1/2]

template<typename _Scalar , typename _StorageIndex >

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

inline

Return the location in rowvaluePtr() which starts each column

122{ return m_rowind_colptr; }

Eigen::internal::MappedSuperNodalMatrix::m_rowind_colptr

StorageIndex * m_rowind_colptr

Definition SparseLU_SupernodalMatrix.h:170

References Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::m_rowind_colptr.

◆ rowIndexPtr() [2/2]

template<typename _Scalar , typename _StorageIndex >

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

inline

    {
      return m_rowind_colptr; 
    }

References Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::m_rowind_colptr.

◆ rows()

template<typename _Scalar , typename _StorageIndex >

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

inline

Number of rows

78{ return m_row; }

Eigen::internal::MappedSuperNodalMatrix::m_row

Index m_row

Definition SparseLU_SupernodalMatrix.h:164

References Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::m_row.

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

    {
      m_row = m;
      m_col = n; 
      m_nzval = nzval.data(); 
      m_nzval_colptr = nzval_colptr.data(); 
      m_rowind = rowind.data(); 
      m_rowind_colptr = rowind_colptr.data(); 
      m_nsuper = col_to_sup(n); 
      m_col_to_sup = col_to_sup.data(); 
      m_sup_to_col = sup_to_col.data(); 
    }

Referenced by Eigen::internal::MappedSuperNodalMatrix< _Scalar, _StorageIndex >::MappedSuperNodalMatrix().

Here is the call graph for this function:

Here is the caller graph for this function:

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

{
    /* Explicit type conversion as the Index type of MatrixBase<Dest> may be wider than Index */
//    eigen_assert(X.rows() <= NumTraits<Index>::highest());
//    eigen_assert(X.cols() <= NumTraits<Index>::highest());
    Index n    = int(X.rows());
    Index nrhs = Index(X.cols());
    const Scalar * Lval = valuePtr();                 // Nonzero values 
    Matrix<Scalar,Dynamic,Dest::ColsAtCompileTime, ColMajor> work(n, nrhs);     // working vector
    work.setZero();
    for (Index k = 0; k <= nsuper(); k ++)
    {
      Index fsupc = supToCol()[k];                    // First column of the current supernode 
      Index istart = rowIndexPtr()[fsupc];            // Pointer index to the subscript of the current column
      Index nsupr = rowIndexPtr()[fsupc+1] - istart;  // Number of rows in the current supernode
      Index nsupc = supToCol()[k+1] - fsupc;          // Number of columns in the current supernode
      Index nrow = nsupr - nsupc;                     // Number of rows in the non-diagonal part of the supernode
      Index irow;                                     //Current index row
      
      if (nsupc == 1 )
      {
        for (Index j = 0; j < nrhs; j++)
        {
          InnerIterator it(*this, fsupc);
          ++it; // Skip the diagonal element
          for (; it; ++it)
          {
            irow = it.row();
            X(irow, j) -= X(fsupc, j) * it.value();
          }
        }
      }
      else
      {
        // The supernode has more than one column 
        Index luptr = colIndexPtr()[fsupc]; 
        Index lda = colIndexPtr()[fsupc+1] - luptr;
        
        // Triangular solve 
        Map<const Matrix<Scalar,Dynamic,Dynamic, ColMajor>, 0, OuterStride<> > A( &(Lval[luptr]), nsupc, nsupc, OuterStride<>(lda) );
        Map< Matrix<Scalar,Dynamic,Dest::ColsAtCompileTime, ColMajor>, 0, OuterStride<> > U (&(X(fsupc,0)), nsupc, nrhs, OuterStride<>(n) );
        U = A.template triangularView<UnitLower>().solve(U); 
        
        // Matrix-vector product 
        new (&A) Map<const Matrix<Scalar,Dynamic,Dynamic, ColMajor>, 0, OuterStride<> > ( &(Lval[luptr+nsupc]), nrow, nsupc, OuterStride<>(lda) );
        work.topRows(nrow).noalias() = A * U;
        
        //Begin Scatter 
        for (Index j = 0; j < nrhs; j++)
        {
          Index iptr = istart + nsupc; 
          for (Index i = 0; i < nrow; i++)
          {
            irow = rowIndex()[iptr]; 
            X(irow, j) -= work(i, j); // Scatter operation
            work(i, j) = Scalar(0); 
            iptr++;
          }
        }
      }
    } 
}