gko::experimental::reorder::Amd< IndexType > Class Template Reference

Computes an Approximate Minimum Degree (AMD) reordering of an input matrix. More...

#include <ginkgo/core/reorder/amd.hpp>

Inheritance diagram for gko::experimental::reorder::Amd< IndexType >:

Collaboration diagram for gko::experimental::reorder::Amd< IndexType >:

Classes
struct	parameters_type

Public Types
using	index_type = IndexType
using	permutation_type = matrix::Permutation< index_type >

Public Member Functions
const parameters_type &	get_parameters ()
	Returns the parameters used to construct the factory. More...
std::unique_ptr< permutation_type >	generate (std::shared_ptr< const LinOp > system_matrix) const
Public Member Functions inherited from gko::LinOpFactory
std::unique_ptr< LinOp >	generate (std::shared_ptr< const LinOp > input) const
Public Member Functions inherited from gko::PolymorphicObject
virtual void	validate_data () const
	Throws gko::InvalidData exception if we found the data inside the object does not fulfill certain property up to our knowledge.
PolymorphicObject &	operator= (const PolymorphicObject &)
std::shared_ptr< const Executor >	get_executor () const noexcept
	Returns the Executor of the object. More...
Public Member Functions inherited from gko::log::EnableLogging< PolymorphicObject >
void	add_logger (std::shared_ptr< const Logger > logger) override
void	remove_logger (const Logger *logger) override
void	remove_logger (ptr_param< const Logger > logger)
const std::vector< std::shared_ptr< const Logger > > &	get_loggers () const override
void	clear_loggers () override
Public Member Functions inherited from gko::log::Loggable
void	remove_logger (ptr_param< const Logger > logger)

Static Public Member Functions
static parameters_type	build ()
	Creates a new parameter_type to set up the factory.

Friends
class	enable_parameters_type< parameters_type, Amd< IndexType > >

Detailed Description

template<typename IndexType = int32>
class gko::experimental::reorder::Amd< IndexType >

Computes an Approximate Minimum Degree (AMD) reordering of an input matrix.

The implementation reuses the AMD routine from the SuiteSparse suite (Tim Davis et al.) — Ginkgo wraps it in a LinOpFactory that produces a gko::matrix::Permutation. The system matrix must therefore be a structurally-symmetric CSR matrix.

References

• Amestoy, P. R., Davis, T. A., Duff, I. S. Algorithm 837: AMD, an Approximate Minimum Degree Ordering Algorithm. ACM Transactions on Mathematical Software, 30 (3), 381–388, 2004. https://doi.org/10.1145/1024074.1024081

Template Parameters

IndexType

the type used to store sparsity pattern indices of the system matrix

Member Function Documentation

generate()

template<typename IndexType = int32>

std::unique_ptr<permutation_type> gko::experimental::reorder::Amd< IndexType >::generate

(

std::shared_ptr< const LinOp >

system_matrix

)

const

Parameters

system_matrix

the source matrix to compute the reordering for.

Note

This function overrides the default LinOpFactory::generate to return a Permutation instead of a generic LinOp, which would need to be cast to Permutation again to access its indices. It is only necessary because smart pointers aren't covariant.

get_parameters()

template<typename IndexType = int32>

const parameters_type& gko::experimental::reorder::Amd< IndexType >::get_parameters ( )

inline

Returns the parameters used to construct the factory.

Returns

the parameters used to construct the factory.

---

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

• ginkgo/core/reorder/amd.hpp