Reordering Algorithms

A module dedicated to the implementation and usage of the reordering algorithms in Ginkgo. More...

Collaboration diagram for Reordering Algorithms:

Namespaces
	gko::experimental::reorder
	The Reorder namespace.
	gko::reorder
	The Reorder namespace.

Classes
class	gko::reorder::Rcm< ValueType, IndexType >
	Rcm (Reverse Cuthill-McKee) is a reordering algorithm minimizing the bandwidth of a matrix. More...
class	gko::experimental::reorder::Rcm< IndexType >
	Rcm (Reverse Cuthill-McKee) is a reordering algorithm minimizing the bandwidth of a matrix. More...

Macros
#define	GKO_ENABLE_REORDERING_BASE_FACTORY(_reordering_base, _parameters_name, _factory_name)
	This macro will generate a default implementation of a ReorderingBaseFactory for the ReorderingBase subclass it is defined in. More...

Detailed Description

A module dedicated to the implementation and usage of the reordering algorithms in Ginkgo.

A reordering permutes the rows and columns of a matrix, for example to reduce fill-in in a factorization or to move large entries onto the diagonal.

Macro Definition Documentation

GKO_ENABLE_REORDERING_BASE_FACTORY

#define GKO_ENABLE_REORDERING_BASE_FACTORY	(		_reordering_base,
			_parameters_name,
			_factory_name
	)

This macro will generate a default implementation of a ReorderingBaseFactory for the ReorderingBase subclass it is defined in.

This macro is very similar to the macro #ENABLE_LIN_OP_FACTORY(). A more detailed description of the use of these type of macros can be found there.

Parameters

_reordering_base	concrete operator for which the factory is to be created [CRTP parameter]
_parameters_name	name of the parameters member in the class (its type is <_parameters_name>_type, the protected member's name is <_parameters_name>_, and the public getter's name is get_<_parameters_name>())
_factory_name	name of the generated factory type