Parallel graph match (Pgm) is the aggregate method introduced in the paper M. More...

#include <ginkgo/core/multigrid/pgm.hpp>

Inheritance diagram for gko::multigrid::Pgm< ValueType, IndexType >:

Collaboration diagram for gko::multigrid::Pgm< ValueType, IndexType >:

Classes
class	Factory

struct	parameters_type

Public Types
using	value_type = ValueType

using	index_type = IndexType

Public Types inherited from gko::EnablePolymorphicAssignment< Pgm< ValueType, IndexType > >
using	result_type = Pgm< ValueType, IndexType >

Public Types inherited from gko::ConvertibleTo< Pgm< ValueType, IndexType > >
using	result_type = Pgm< ValueType, IndexType >

Public Types inherited from gko::multigrid::EnableMultigridLevel< ValueType >
using	value_type = ValueType

Public Types inherited from gko::UseComposition< ValueType >
using	value_type = ValueType

Public Member Functions
std::shared_ptr< const LinOp >	get_system_matrix () const
	Returns the system operator (matrix) of the linear system. More...

IndexType *	get_agg () noexcept
	Returns the aggregate group. More...

const IndexType *	get_const_agg () const noexcept
	Returns the aggregate group. More...

const parameters_type &	get_parameters () const

Public Member Functions inherited from gko::EnableLinOp< Pgm< ValueType, IndexType > >
const Pgm< ValueType, IndexType > *	apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const

Pgm< ValueType, IndexType > *	apply (ptr_param< const LinOp > b, ptr_param< LinOp > x)

const Pgm< ValueType, IndexType > *	apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x) const

Pgm< ValueType, IndexType > *	apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x)

Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< Pgm< ValueType, IndexType >, LinOp >
std::unique_ptr< Pgm< ValueType, IndexType > >	create_default (std::shared_ptr< const Executor > exec) const

std::unique_ptr< Pgm< ValueType, IndexType > >	create_default () const

std::unique_ptr< Pgm< ValueType, IndexType > >	clone (std::shared_ptr< const Executor > exec) const

std::unique_ptr< Pgm< ValueType, IndexType > >	clone () const

Pgm< ValueType, IndexType > *	copy_from (const PolymorphicObject *other)

std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, Pgm< ValueType, IndexType > > *	copy_from (std::unique_ptr< Derived > &&other)

std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, Pgm< ValueType, IndexType > > *	copy_from (const std::unique_ptr< Derived > &other)

Pgm< ValueType, IndexType > *	copy_from (const std::shared_ptr< const PolymorphicObject > &other)

Pgm< ValueType, IndexType > *	move_from (ptr_param< PolymorphicObject > other)

Pgm< ValueType, IndexType > *	clear ()

Public Member Functions inherited from gko::LinOp
LinOp *	apply (ptr_param< const LinOp > b, ptr_param< LinOp > x)
	Applies a linear operator to a vector (or a sequence of vectors). More...

const LinOp *	apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const

LinOp *	apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x)
	Performs the operation x = alpha * op(b) + beta * x. More...

const LinOp *	apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x) const

const dim< 2 > &	get_size () const noexcept
	Returns the size of the operator. More...

virtual bool	apply_uses_initial_guess () const
	Returns true if the linear operator uses the data given in x as an initial guess. More...

LinOp &	operator= (const LinOp &)=default
	Copy-assigns a LinOp. More...

LinOp &	operator= (LinOp &&other)
	Move-assigns a LinOp. More...

	LinOp (const LinOp &)=default
	Copy-constructs a LinOp. More...

	LinOp (LinOp &&other)
	Move-constructs a LinOp. More...

Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< LinOp >
std::unique_ptr< LinOp >	create_default (std::shared_ptr< const Executor > exec) const

std::unique_ptr< LinOp >	create_default () const

std::unique_ptr< LinOp >	clone (std::shared_ptr< const Executor > exec) const

std::unique_ptr< LinOp >	clone () const

LinOp *	copy_from (const PolymorphicObject *other)

std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, LinOp > *	copy_from (std::unique_ptr< Derived > &&other)

std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, LinOp > *	copy_from (const std::unique_ptr< Derived > &other)

LinOp *	copy_from (const std::shared_ptr< const PolymorphicObject > &other)

LinOp *	move_from (ptr_param< PolymorphicObject > other)

LinOp *	clear ()

Public Member Functions inherited from gko::PolymorphicObject
PolymorphicObject &	operator= (const PolymorphicObject &)

std::unique_ptr< PolymorphicObject >	create_default (std::shared_ptr< const Executor > exec) const
	Creates a new "default" object of the same dynamic type as this object. More...

std::unique_ptr< PolymorphicObject >	create_default () const
	Creates a new "default" object of the same dynamic type as this object. More...

std::unique_ptr< PolymorphicObject >	clone (std::shared_ptr< const Executor > exec) const
	Creates a clone of the object. More...

std::unique_ptr< PolymorphicObject >	clone () const
	Creates a clone of the object. More...

PolymorphicObject *	copy_from (const PolymorphicObject *other)
	Copies another object into this object. More...

template<typename Derived , typename Deleter >
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, PolymorphicObject > *	copy_from (std::unique_ptr< Derived, Deleter > &&other)
	Moves another object into this object. More...

template<typename Derived , typename Deleter >
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, PolymorphicObject > *	copy_from (const std::unique_ptr< Derived, Deleter > &other)
	Copies another object into this object. More...

PolymorphicObject *	copy_from (const std::shared_ptr< const PolymorphicObject > &other)
	Copies another object into this object. More...

PolymorphicObject *	move_from (ptr_param< PolymorphicObject > other)
	Moves another object into this object. More...

PolymorphicObject *	clear ()
	Transforms the object into its default state. More...

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)

Public Member Functions inherited from gko::EnablePolymorphicAssignment< Pgm< ValueType, IndexType > >
void	convert_to (result_type *result) const override
	Converts the implementer to an object of type result_type. More...

void	move_to (result_type *result) override
	Converts the implementer to an object of type result_type by moving data from this object. More...

Public Member Functions inherited from gko::ConvertibleTo< Pgm< ValueType, IndexType > >
void	convert_to (ptr_param< result_type > result) const

void	move_to (ptr_param< result_type > result)

Public Member Functions inherited from gko::multigrid::EnableMultigridLevel< ValueType >
std::shared_ptr< const LinOp >	get_fine_op () const override
	Returns the operator on fine level. More...

std::shared_ptr< const LinOp >	get_restrict_op () const override
	Returns the restrict operator. More...

std::shared_ptr< const LinOp >	get_coarse_op () const override
	Returns the operator on coarse level. More...

std::shared_ptr< const LinOp >	get_prolong_op () const override
	Returns the prolong operator. More...

Public Member Functions inherited from gko::UseComposition< ValueType >
std::shared_ptr< Composition< ValueType > >	get_composition () const
	Returns the composition operators. More...

std::shared_ptr< const LinOp >	get_operator_at (size_type index) const
	Returns the operator at index-th position of composition. More...

Static Public Member Functions
static auto	build () -> decltype(Factory ::create())

Friends
class	EnableLinOp< Pgm >

class	EnablePolymorphicObject< Pgm, LinOp >

Detailed Description

template<typename ValueType = default_precision, typename IndexType = int32>
class gko::multigrid::Pgm< ValueType, IndexType >

Parallel graph match (Pgm) is the aggregate method introduced in the paper M.

Naumov et al., "AmgX: A Library for GPU Accelerated Algebraic Multigrid and Preconditioned Iterative Methods". Current implementation only contains size = 2 version.

Pgm creates the aggregate group according to the matrix value not the structure. Pgm gives two steps (one-phase handshaking) to group the elements. 1: get the strongest neighbor of each unaggregated element. 2: group the elements whose strongest neighbor is each other. repeating until reaching the given conditions. After that, the un-aggregated elements are assigned to an aggregated group or are left alone.

Template Parameters

ValueType	precision of matrix elements
IndexType	precision of matrix indexes

Member Function Documentation

◆ get_agg()

template<typename ValueType = default_precision, typename IndexType = int32>

IndexType* gko::multigrid::Pgm< ValueType, IndexType >::get_agg ( )

inlinenoexcept

Returns the aggregate group.

Aggregate group whose size is same as the number of rows. Stores the mapping information from row index to coarse row index. i.e., agg[row_idx] = coarse_row_idx.

Returns: the aggregate group.

References gko::array< ValueType >::get_data().

◆ get_const_agg()

template<typename ValueType = default_precision, typename IndexType = int32>

const IndexType* gko::multigrid::Pgm< ValueType, IndexType >::get_const_agg ( ) const

inlinenoexcept

Returns the aggregate group.

Aggregate group whose size is same as the number of rows. Stores the mapping information from row index to coarse row index. i.e., agg[row_idx] = coarse_row_idx.

Returns: the aggregate group.

Note: This is the constant version of the function, which can be significantly more memory efficient than the non-constant version, so always prefer this version.

References gko::array< ValueType >::get_const_data().

◆ get_system_matrix()

template<typename ValueType = default_precision, typename IndexType = int32>

std::shared_ptr<const LinOp> gko::multigrid::Pgm< ValueType, IndexType >::get_system_matrix ( ) const

inline

Returns the system operator (matrix) of the linear system.

Returns: the system operator (matrix)

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

ginkgo/core/multigrid/pgm.hpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

template<typename ValueType = default_precision, typename IndexType = int32> class gko::multigrid::Pgm< ValueType, IndexType >

Member Function Documentation

◆ get_agg()

◆ get_const_agg()

◆ get_system_matrix()

template<typename ValueType = default_precision, typename IndexType = int32>
class gko::multigrid::Pgm< ValueType, IndexType >