Public Types | Public Member Functions | List of all members
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
StorageIndexThe 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 114 of file 3rdparty/Eigen/Eigen/src/OrderingMethods/Ordering.h.

Member Typedef Documentation

◆ IndexVector

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

◆ PermutationType

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

Member Function Documentation

◆ operator()()

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 124 of file 3rdparty/Eigen/Eigen/src/OrderingMethods/Ordering.h.


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


gtsam
Author(s):
autogenerated on Fri Nov 1 2024 03:44:34