RowGatherer is a matrix "format" which stores the gather indices arrays which can be used to gather rows to another matrix. More...

#include <ginkgo/core/matrix/row_gatherer.hpp>

Inheritance diagram for gko::matrix::RowGatherer< IndexType >:

[legend]

Collaboration diagram for gko::matrix::RowGatherer< IndexType >:

[legend]

Public Types
using	index_type = IndexType

Public Types inherited from gko::EnablePolymorphicAssignment< RowGatherer< IndexType > >
using	result_type = RowGatherer< IndexType >

Public Types inherited from gko::ConvertibleTo< RowGatherer< IndexType > >
using	result_type = RowGatherer< IndexType >

Public Member Functions
index_type *	get_row_idxs () noexcept
	Returns a pointer to the row index array for gathering. More...

const index_type *	get_const_row_idxs () const noexcept
	Returns a pointer to the row index array for gathering. More...

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

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

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

RowGatherer< 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< RowGatherer< IndexType >, LinOp >
std::unique_ptr< RowGatherer< IndexType > >	create_default (std::shared_ptr< const Executor > exec) const

std::unique_ptr< RowGatherer< IndexType > >	create_default () const

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

std::unique_ptr< RowGatherer< IndexType > >	clone () const

RowGatherer< IndexType > *	copy_from (const PolymorphicObject *other)

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

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

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

RowGatherer< IndexType > *	move_from (ptr_param< PolymorphicObject > other)

RowGatherer< 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< RowGatherer< 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< RowGatherer< IndexType > >
void	convert_to (ptr_param< result_type > result) const

void	move_to (ptr_param< result_type > result)

Static Public Member Functions
static std::unique_ptr< RowGatherer >	create (std::shared_ptr< const Executor > exec, const dim< 2 > &size={})
	Creates uninitialized RowGatherer arrays of the specified size. More...

static std::unique_ptr< RowGatherer >	create (std::shared_ptr< const Executor > exec, const dim< 2 > &size, array< index_type > row_idxs)
	Creates a RowGatherer matrix from an already allocated (and initialized) row gathering array. More...

static std::unique_ptr< const RowGatherer >	create_const (std::shared_ptr< const Executor > exec, const dim< 2 > &size, gko::detail::const_array_view< IndexType > &&row_idxs)
	Creates a constant (immutable) RowGatherer matrix from a constant array. More...

Friends
class	EnablePolymorphicObject< RowGatherer, LinOp >

Detailed Description

template<typename IndexType = int32>
class gko::matrix::RowGatherer< IndexType >

RowGatherer is a matrix "format" which stores the gather indices arrays which can be used to gather rows to another matrix.

Template Parameters

IndexType precision of rowgatherer array indices.

Note: This format is used mainly to allow for an abstraction of the rowgatherer and provides the user with an apply method which calls the respective Dense rowgatherer operation. As such it only stores an array of the rowgatherer indices.

Member Function Documentation

◆ create() [1/2]

template<typename IndexType = int32>

static std::unique_ptr<RowGatherer> gko::matrix::RowGatherer< IndexType >::create	(	std::shared_ptr< const Executor >	exec,
		const dim< 2 > &	size,
		array< index_type >	row_idxs
	)

static

Creates a RowGatherer matrix from an already allocated (and initialized) row gathering array.

Parameters

exec	Executor associated to the matrix
size	size of the rowgatherer array.
row_idxs	array of rowgatherer array

Note: If row_idxs is not an rvalue, not an array of IndexType, or is on the wrong executor, an internal copy will be created, and the original array data will not be used in the matrix.

Returns: A smart pointer to the newly created matrix.

◆ create() [2/2]

template<typename IndexType = int32>

static std::unique_ptr<RowGatherer> gko::matrix::RowGatherer< IndexType >::create	(	std::shared_ptr< const Executor >	exec,
		const dim< 2 > &	size = `{}`
	)

static

Creates uninitialized RowGatherer arrays of the specified size.

Parameters

exec	Executor associated to the matrix
size	size of the RowGatherable matrix

Returns: A smart pointer to the newly created matrix.

◆ create_const()

template<typename IndexType = int32>

static std::unique_ptr<const RowGatherer> gko::matrix::RowGatherer< IndexType >::create_const	(	std::shared_ptr< const Executor >	exec,
		const dim< 2 > &	size,
		gko::detail::const_array_view< IndexType > &&	row_idxs
	)

static

Creates a constant (immutable) RowGatherer matrix from a constant array.

Parameters

exec	the executor to create the matrix on
size	the dimensions of the matrix
row_idxs	the gathered row indices of the matrix

Returns: A smart pointer to the constant matrix wrapping the input arrays (if they reside on the same executor as the matrix) or a copy of the arrays on the correct executor.

◆ get_const_row_idxs()

template<typename IndexType = int32>

const index_type* gko::matrix::RowGatherer< IndexType >::get_const_row_idxs ( ) const

inlinenoexcept

Returns a pointer to the row index array for gathering.

Returns: the pointer to the row index array for gathering.

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_row_idxs()

template<typename IndexType = int32>

index_type* gko::matrix::RowGatherer< IndexType >::get_row_idxs ( )

inlinenoexcept

Returns a pointer to the row index array for gathering.

Returns: the pointer to the row index array for gathering.

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

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

ginkgo/core/matrix/row_gatherer.hpp

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

template<typename IndexType = int32> class gko::matrix::RowGatherer< IndexType >

Member Function Documentation

◆ create() [1/2]

◆ create() [2/2]

◆ create_const()

◆ get_const_row_idxs()

◆ get_row_idxs()

template<typename IndexType = int32>
class gko::matrix::RowGatherer< IndexType >