#include <ginkgo/core/base/combination.hpp>

Inheritance diagram for gko::Combination< ValueType >:

Public Types
using	value_type = ValueType

using	transposed_type = Combination< ValueType >

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

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

Public Member Functions
const std::vector< std::shared_ptr< const LinOp > > &	get_coefficients () const noexcept

const std::vector< std::shared_ptr< const LinOp > > &	get_operators () const noexcept

std::unique_ptr< LinOp >	transpose () const override

std::unique_ptr< LinOp >	conj_transpose () const override

Combination &	operator= (const Combination &)

Combination &	operator= (Combination &&)

	Combination (const Combination &)

	Combination (Combination &&)

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

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

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

ConcreteLinOp *	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< AbstractObject, PolymorphicBase >
std::unique_ptr< AbstractObject >	create_default (std::shared_ptr< const Executor > exec) const

std::unique_ptr< AbstractObject >	create_default () const

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

std::unique_ptr< AbstractObject >	clone () const

AbstractObject *	copy_from (const PolymorphicObject *other)

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

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

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

AbstractObject *	move_from (ptr_param< PolymorphicObject > other)

AbstractObject *	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

std::unique_ptr< PolymorphicObject >	create_default () const

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

std::unique_ptr< PolymorphicObject >	clone () const

PolymorphicObject *	copy_from (const PolymorphicObject *other)

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)

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)

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

PolymorphicObject *	move_from (ptr_param< PolymorphicObject > other)

PolymorphicObject *	clear ()

std::shared_ptr< const Executor >	get_executor () const noexcept

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< ConcreteLinOp >
void	convert_to (result_type *result) const override

void	move_to (result_type *result) override

Public Member Functions inherited from gko::ConvertibleTo< ResultType >
virtual void	convert_to (result_type *result) const =0

void	convert_to (ptr_param< result_type > result) const

virtual void	move_to (result_type *result)=0

void	move_to (ptr_param< result_type > result)

Protected Member Functions
void	add_operators ()

template<typename... Rest>
void	add_operators (std::shared_ptr< const LinOp > coef, std::shared_ptr< const LinOp > oper, Rest &&... rest)

	Combination (std::shared_ptr< const Executor > exec)

template<typename CoefficientIterator , typename OperatorIterator , typename = std::void_t< typename std::iterator_traits< CoefficientIterator>::iterator_category, typename std::iterator_traits<OperatorIterator>::iterator_category>>
	Combination (CoefficientIterator coefficient_begin, CoefficientIterator coefficient_end, OperatorIterator operator_begin, OperatorIterator operator_end)

template<typename... Rest>
	Combination (std::shared_ptr< const LinOp > coef, std::shared_ptr< const LinOp > oper, Rest &&... rest)

void	apply_impl (const LinOp b, LinOp x) const override

void	apply_impl (const LinOp alpha, const LinOp b, const LinOp beta, LinOp x) const override

Protected Member Functions inherited from gko::EnableLinOp< ConcreteLinOp, PolymorphicBase >
ConcreteLinOp *	self () noexcept

const ConcreteLinOp *	self () const noexcept

Protected Member Functions inherited from gko::EnablePolymorphicObject< ConcreteObject, PolymorphicBase >
std::unique_ptr< PolymorphicObject >	create_default_impl (std::shared_ptr< const Executor > exec) const override

PolymorphicObject *	copy_from_impl (const PolymorphicObject *other) override

PolymorphicObject *	copy_from_impl (std::unique_ptr< PolymorphicObject > other) override

PolymorphicObject *	move_from_impl (PolymorphicObject *other) override

PolymorphicObject *	move_from_impl (std::unique_ptr< PolymorphicObject > other) override

PolymorphicObject *	clear_impl () override

Protected Member Functions inherited from gko::PolymorphicObject
	PolymorphicObject (std::shared_ptr< const Executor > exec)

	PolymorphicObject (const PolymorphicObject &other)

Protected Member Functions inherited from gko::log::EnableLogging< PolymorphicObject >
void	log (Params &&... params) const

Friends
class	EnablePolymorphicObject< Combination, LinOp >

class	EnableCreateMethod< Combination >

Additional Inherited Members
Static Public Member Functions inherited from gko::EnableCreateMethod< ConcreteType >
template<typename... Args>
static std::unique_ptr< ConcreteType >	create (Args &&... args)

Protected Attributes inherited from gko::log::EnableLogging< PolymorphicObject >
std::vector< std::shared_ptr< const Logger > >	loggers_

Detailed Description

template<typename ValueType = default_precision>
class gko::Combination< ValueType >

The Combination class can be used to construct a linear combination of multiple linear operators c1 * op1 + c2 * op2 + ... + ck * opk.

Combination ensures that all LinOps passed to its constructor use the same executor, and if not, copies the operators to the executor of the first operator.

Template Parameters

ValueType precision of input and result vectors

Constructor & Destructor Documentation

◆ Combination() [1/5]

template<typename ValueType = default_precision>

gko::Combination< ValueType >::Combination ( const Combination< ValueType > & )

Copy-constructs a Combination. This inherits the executor of the input Combination and all of its operators with shared ownership.

◆ Combination() [2/5]

template<typename ValueType = default_precision>

gko::Combination< ValueType >::Combination ( Combination< ValueType > && )

Move-constructs a Combination. This inherits the executor of the input Combination and all of its operators. The moved-from object is empty (0x0 LinOp without operators) afterwards.

◆ Combination() [3/5]

template<typename ValueType = default_precision>

gko::Combination< ValueType >::Combination ( std::shared_ptr< const Executor > exec )

inlineexplicitprotected

Creates an empty linear combination (0x0 operator).

Parameters

exec	Executor associated to the linear combination

◆ Combination() [4/5]

template<typename ValueType = default_precision>

template<typename CoefficientIterator , typename OperatorIterator , typename = std::void_t< typename std::iterator_traits< CoefficientIterator>::iterator_category, typename std::iterator_traits<OperatorIterator>::iterator_category>>

gko::Combination< ValueType >::Combination	(	CoefficientIterator	coefficient_begin,
		CoefficientIterator	coefficient_end,
		OperatorIterator	operator_begin,
		OperatorIterator	operator_end
	)

inlineexplicitprotected

Creates a linear combination of operators using the specified list of coefficients and operators.

Template Parameters

CoefficientIterator	a class representing iterators over the coefficients of the linear combination
OperatorIterator	a class representing iterators over the operators of the linear combination

Parameters

coefficient_begin	iterator pointing to the first coefficient
coefficient_end	iterator pointing behind the last coefficient
operator_begin	iterator pointing to the first operator
operator_end	iterator pointing behind the last operator

◆ Combination() [5/5]

template<typename ValueType = default_precision>

template<typename... Rest>

gko::Combination< ValueType >::Combination	(	std::shared_ptr< const LinOp >	coef,
		std::shared_ptr< const LinOp >	oper,
		Rest &&...	rest
	)

inlineexplicitprotected

Creates a linear combination of operators using the specified list of coefficients and operators.

Template Parameters

Rest	types of trailing parameters

Parameters

coef	the first coefficient
oper	the first operator
rest	other coefficient and operators (interleaved)

Member Function Documentation

◆ conj_transpose()

template<typename ValueType = default_precision>

std::unique_ptr< LinOp > gko::Combination< ValueType >::conj_transpose ( ) const

overridevirtual

Returns a LinOp representing the conjugate transpose of the Transposable object.

Returns: a pointer to the new conjugate transposed object

Implements gko::Transposable.

◆ get_coefficients()

template<typename ValueType = default_precision>

const std::vector< std::shared_ptr< const LinOp > > & gko::Combination< ValueType >::get_coefficients ( ) const

inlinenoexcept

Returns a list of coefficients of the combination.

Returns: a list of coefficients

◆ get_operators()

template<typename ValueType = default_precision>

const std::vector< std::shared_ptr< const LinOp > > & gko::Combination< ValueType >::get_operators ( ) const

inlinenoexcept

Returns a list of operators of the combination.

Returns: a list of operators

◆ operator=() [1/2]

template<typename ValueType = default_precision>

Combination & gko::Combination< ValueType >::operator= ( Combination< ValueType > && )

Move-assigns a Combination. The executor is not modified, and the wrapped LinOps are only being cloned if they are on a different executor, otherwise they share ownership. The moved-from object is empty (0x0 LinOp without operators) afterwards.

◆ operator=() [2/2]

template<typename ValueType = default_precision>

Combination & gko::Combination< ValueType >::operator= ( const Combination< ValueType > & )

Copy-assigns a Combination. The executor is not modified, and the wrapped LinOps are only being cloned if they are on a different executor.

◆ transpose()

template<typename ValueType = default_precision>

std::unique_ptr< LinOp > gko::Combination< ValueType >::transpose ( ) const

overridevirtual

Returns a LinOp representing the transpose of the Transposable object.

Returns: a pointer to the new transposed object

Implements gko::Transposable.

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

ginkgo/core/base/combination.hpp

Combination< ValueType > Class Template Reference

Combination< ValueType > Class Template Reference#

Public Types

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Combination() [1/5]

◆ Combination() [2/5]

◆ Combination() [3/5]

◆ Combination() [4/5]

◆ Combination() [5/5]

Member Function Documentation

◆ conj_transpose()

◆ get_coefficients()

◆ get_operators()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ transpose()

Combination< ValueType > Class Template Reference

Combination&lt; ValueType &gt; Class Template Reference#

Public Types

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Combination() [1/5]

◆ Combination() [2/5]

◆ Combination() [3/5]

◆ Combination() [4/5]

◆ Combination() [5/5]

Member Function Documentation

◆ conj_transpose()

◆ get_coefficients()

◆ get_operators()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ transpose()

Combination< ValueType > Class Template Reference#