WPILibC++ 2023.4.3
Eigen::AMDOrdering< StorageIndex > Class Template Reference

Functor computing the approximate minimum degree ordering If the matrix is not structurally symmetric, an ordering of A^T+A is computed. More...

#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/OrderingMethods/Ordering.h>

Public Types

typedef PermutationMatrix< Dynamic, Dynamic, StorageIndex > PermutationType
 

Public Member Functions

template<typename MatrixType >
void operator() (const MatrixType &mat, PermutationType &perm)
 Compute the permutation vector from a sparse matrix This routine is much faster if the input matrix is column-major
More...
 
template<typename SrcType , unsigned int SrcUpLo>
void operator() (const SparseSelfAdjointView< SrcType, SrcUpLo > &mat, PermutationType &perm)
 Compute the permutation with a selfadjoint matrix. More...
 

Detailed Description

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

Functor computing the approximate minimum degree ordering If the matrix is not structurally symmetric, an ordering of A^T+A is computed.

Template Parameters
StorageIndexThe type of indices of the matrix
See also
COLAMDOrdering

Member Typedef Documentation

◆ PermutationType

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

Member Function Documentation

◆ operator()() [1/2]

template<typename StorageIndex >
template<typename MatrixType >
void Eigen::AMDOrdering< StorageIndex >::operator() ( const MatrixType &  mat,
PermutationType perm 
)
inline

Compute the permutation vector from a sparse matrix This routine is much faster if the input matrix is column-major

◆ operator()() [2/2]

template<typename StorageIndex >
template<typename SrcType , unsigned int SrcUpLo>
void Eigen::AMDOrdering< StorageIndex >::operator() ( const SparseSelfAdjointView< SrcType, SrcUpLo > &  mat,
PermutationType perm 
)
inline

Compute the permutation with a selfadjoint matrix.


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