Eigen::COLAMDOrdering< StorageIndex > Class Template Reference

#include <Ordering.h>

Public Types
typedef Matrix< StorageIndex, Dynamic, 1 >	IndexVector
typedef PermutationMatrix< Dynamic, Dynamic, StorageIndex >	PermutationType

Public Member Functions
template<typename MatrixType >
void	operator() (const MatrixType &mat, PermutationType &perm)

Detailed Description

template<typename StorageIndex>
class Eigen::COLAMDOrdering< StorageIndex >

Template Parameters

StorageIndex

The type of indices of the matrix

Functor computing the column approximate minimum degree ordering The matrix should be in column-major and compressed format (see SparseMatrix::makeCompressed()).

Definition at line 118 of file Ordering.h.

Member Typedef Documentation

template<typename StorageIndex>

typedef Matrix<StorageIndex, Dynamic, 1> Eigen::COLAMDOrdering< StorageIndex >::IndexVector

Definition at line 122 of file Ordering.h.

template<typename StorageIndex>

typedef PermutationMatrix<Dynamic, Dynamic, StorageIndex> Eigen::COLAMDOrdering< StorageIndex >::PermutationType

Definition at line 121 of file Ordering.h.

Member Function Documentation

template<typename StorageIndex>

template<typename MatrixType >

void Eigen::COLAMDOrdering< StorageIndex >::operator() ( const MatrixType &  mat, PermutationType &  perm  )

inline

Compute the permutation vector perm form the sparse matrix mat

Warning

The input sparse matrix mat must be in compressed mode (see SparseMatrix::makeCompressed()).

Definition at line 128 of file Ordering.h.

---

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

• Ordering.h