num_collect::linear::cuthill_mckee_ordering< StorageIndex > Class Template Reference

Class to perform Cuthill-McKee ordering method [7], [16]. More...

#include <num_collect/linear/cuthill_mckee_ordering.h>

Collaboration diagram for num_collect::linear::cuthill_mckee_ordering< StorageIndex >:

Public Types
using	permutation_type
	Type of permutations.
using	PermutationType = permutation_type
	Type of permutations (for Eigen library).
using	storage_index_type = StorageIndex
	Type of indices in storages of indices.

Public Member Functions
	cuthill_mckee_ordering ()=default
	Constructor.
template<typename MatrixType , unsigned int Mode>
void	operator() (const Eigen::SparseSelfAdjointView< MatrixType, Mode > &matrix, permutation_type &permutation)
	Create a permutation matrix from SparseSelfAdjointView object.
template<base::concepts::sparse_matrix MatrixType>
void	operator() (const MatrixType &matrix, permutation_type &permutation)
	Create a permutation matrix.

Detailed Description

template<typename StorageIndex>
class num_collect::linear::cuthill_mckee_ordering< StorageIndex >

Class to perform Cuthill-McKee ordering method [7], [16].

Definition at line 248 of file cuthill_mckee_ordering.h.

Member Typedef Documentation

permutation_type

template<typename StorageIndex >

using num_collect::linear::cuthill_mckee_ordering< StorageIndex >::permutation_type

Initial value:

 Eigen::PermutationMatrix<Eigen::Dynamic,
        Eigen::Dynamic, storage_index_type>

Type of permutations.

Definition at line 254 of file cuthill_mckee_ordering.h.

PermutationType

template<typename StorageIndex >

using num_collect::linear::cuthill_mckee_ordering< StorageIndex >::PermutationType = permutation_type

Type of permutations (for Eigen library).

Definition at line 258 of file cuthill_mckee_ordering.h.

storage_index_type

template<typename StorageIndex >

using num_collect::linear::cuthill_mckee_ordering< StorageIndex >::storage_index_type = StorageIndex

Type of indices in storages of indices.

Definition at line 251 of file cuthill_mckee_ordering.h.

Member Function Documentation

operator()() [1/2]

template<typename StorageIndex >

template<typename MatrixType , unsigned int Mode>

void num_collect::linear::cuthill_mckee_ordering< StorageIndex >::operator() ( const Eigen::SparseSelfAdjointView< MatrixType, Mode > & matrix, permutation_type & permutation )

inline

Create a permutation matrix from SparseSelfAdjointView object.

Template Parameters

MatrixType	Type of the input matrix.
Mode	Mode of the input matrix.

Parameters

[in]	matrix	Input matrix.
[in]	permutation	Permutation matrix.

Definition at line 285 of file cuthill_mckee_ordering.h.

operator()() [2/2]

template<typename StorageIndex >

template<base::concepts::sparse_matrix MatrixType>

void num_collect::linear::cuthill_mckee_ordering< StorageIndex >::operator() ( const MatrixType & matrix, permutation_type & permutation )

inline

Create a permutation matrix.

Template Parameters

MatrixType

Type of the input matrix.

Parameters

[in]	matrix	Input matrix.
[out]	permutation	Permutation matrix.

Definition at line 271 of file cuthill_mckee_ordering.h.

---

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

• include/num_collect/linear/cuthill_mckee_ordering.h