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 _Index | Index |
typedef Matrix< Index, Dynamic, 1 > | IndexVector |
typedef _Scalar | Scalar |
typedef Matrix< Scalar, Dynamic, 1 > | ScalarVector |
Public Member Functions | |
Index * | colIndexPtr () |
const Index * | colIndexPtr () const |
Index | cols () |
Index * | colToSup () |
const Index * | 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 |
Index * | rowIndex () |
const Index * | rowIndex () const |
Index * | rowIndexPtr () |
const Index * | 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. | |
Index * | supToCol () |
const Index * | supToCol () const |
Scalar * | valuePtr () |
const Scalar * | valuePtr () const |
~MappedSuperNodalMatrix () | |
Protected Attributes | |
Index | m_col |
Index * | m_col_to_sup |
Index | m_nsuper |
Scalar * | m_nzval |
Index * | m_nzval_colptr |
Index | m_row |
Index * | m_rowind |
Index * | m_rowind_colptr |
Index * | m_sup_to_col |
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.
typedef _Index Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index >::Index |
Definition at line 37 of file SparseLU_SupernodalMatrix.h.
typedef Matrix<Index,Dynamic,1> Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index >::IndexVector |
Definition at line 38 of file SparseLU_SupernodalMatrix.h.
typedef _Scalar Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index >::Scalar |
Definition at line 36 of file SparseLU_SupernodalMatrix.h.
typedef Matrix<Scalar,Dynamic,1> Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index >::ScalarVector |
Definition at line 39 of file SparseLU_SupernodalMatrix.h.
Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index >::MappedSuperNodalMatrix | ( | ) | [inline] |
Definition at line 41 of file SparseLU_SupernodalMatrix.h.
Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index >::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.
Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index >::~MappedSuperNodalMatrix | ( | ) | [inline] |
Definition at line 51 of file SparseLU_SupernodalMatrix.h.
Index* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index >::colIndexPtr | ( | ) | [inline] |
Return the pointers to the beginning of each column in valuePtr()
Definition at line 99 of file SparseLU_SupernodalMatrix.h.
const Index* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index >::colIndexPtr | ( | ) | const [inline] |
Definition at line 104 of file SparseLU_SupernodalMatrix.h.
Index Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index >::cols | ( | void | ) | [inline] |
Number of columns
Definition at line 83 of file SparseLU_SupernodalMatrix.h.
Index* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index >::colToSup | ( | ) | [inline] |
Return the array of column-to-supernode mapping
Definition at line 132 of file SparseLU_SupernodalMatrix.h.
const Index* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index >::colToSup | ( | ) | const [inline] |
Definition at line 134 of file SparseLU_SupernodalMatrix.h.
Index Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index >::nsuper | ( | ) | const [inline] |
Return the number of supernodes
Definition at line 151 of file SparseLU_SupernodalMatrix.h.
Index* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index >::rowIndex | ( | ) | [inline] |
Return the array of compressed row indices of all supernodes
Definition at line 112 of file SparseLU_SupernodalMatrix.h.
const Index* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index >::rowIndex | ( | ) | const [inline] |
Definition at line 114 of file SparseLU_SupernodalMatrix.h.
Index* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index >::rowIndexPtr | ( | ) | [inline] |
Return the location in rowvaluePtr() which starts each column
Definition at line 122 of file SparseLU_SupernodalMatrix.h.
const Index* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index >::rowIndexPtr | ( | ) | const [inline] |
Definition at line 124 of file SparseLU_SupernodalMatrix.h.
Index Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index >::rows | ( | void | ) | [inline] |
Number of rows
Definition at line 78 of file SparseLU_SupernodalMatrix.h.
void Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index >::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.
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.
Index* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index >::supToCol | ( | ) | [inline] |
Return the array of supernode-to-column mapping
Definition at line 141 of file SparseLU_SupernodalMatrix.h.
const Index* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index >::supToCol | ( | ) | const [inline] |
Definition at line 143 of file SparseLU_SupernodalMatrix.h.
Scalar* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index >::valuePtr | ( | ) | [inline] |
Return the array of nonzero values packed by column
The size is nnz
Definition at line 90 of file SparseLU_SupernodalMatrix.h.
const Scalar* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index >::valuePtr | ( | ) | const [inline] |
Definition at line 92 of file SparseLU_SupernodalMatrix.h.
Index Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index >::m_col [protected] |
Definition at line 165 of file SparseLU_SupernodalMatrix.h.
Index* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index >::m_col_to_sup [protected] |
Definition at line 171 of file SparseLU_SupernodalMatrix.h.
Index Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index >::m_nsuper [protected] |
Definition at line 166 of file SparseLU_SupernodalMatrix.h.
Scalar* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index >::m_nzval [protected] |
Definition at line 167 of file SparseLU_SupernodalMatrix.h.
Index* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index >::m_nzval_colptr [protected] |
Definition at line 168 of file SparseLU_SupernodalMatrix.h.
Index Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index >::m_row [protected] |
Definition at line 164 of file SparseLU_SupernodalMatrix.h.
Index* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index >::m_rowind [protected] |
Definition at line 169 of file SparseLU_SupernodalMatrix.h.
Index* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index >::m_rowind_colptr [protected] |
Definition at line 170 of file SparseLU_SupernodalMatrix.h.
Index* Eigen::internal::MappedSuperNodalMatrix< _Scalar, _Index >::m_sup_to_col [protected] |
Definition at line 172 of file SparseLU_SupernodalMatrix.h.