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

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

Inheritance diagram for gko::Combination< ValueType >:

[legend]

Collaboration diagram for gko::Combination< ValueType >:

[legend]

Public Types
using	value_type = ValueType

using	transposed_type = Combination< ValueType >

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

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

Public Member Functions
const std::vector< std::shared_ptr< const LinOp > > &	get_coefficients () const noexcept
	Returns a list of coefficients of the combination. More...

const std::vector< std::shared_ptr< const LinOp > > &	get_operators () const noexcept
	Returns a list of operators of the combination. More...

std::unique_ptr< LinOp >	transpose () const override
	Returns a LinOp representing the transpose of the Transposable object. More...

std::unique_ptr< LinOp >	conj_transpose () const override
	Returns a LinOp representing the conjugate transpose of the Transposable object. More...

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

Combination &	operator= (Combination &&)
	Move-assigns a Combination. More...

	Combination (const Combination &)
	Copy-constructs a Combination. More...

	Combination (Combination &&)
	Move-constructs a Combination. More...

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

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

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

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

std::unique_ptr< Combination< ValueType > >	create_default () const

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

std::unique_ptr< Combination< ValueType > >	clone () const

Combination< ValueType > *	copy_from (const PolymorphicObject *other)

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

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

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

Combination< ValueType > *	move_from (ptr_param< PolymorphicObject > other)

Combination< ValueType > *	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< Combination< ValueType > >
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< Combination< ValueType > >
void	convert_to (ptr_param< result_type > result) const

void	move_to (ptr_param< result_type > result)

Friends
class	EnablePolymorphicObject< Combination, LinOp >

class	EnableCreateMethod< Combination >

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

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/2]

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/2]

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.

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

Public Types

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

◆ Combination() [1/2]

◆ Combination() [2/2]

Member Function Documentation

◆ conj_transpose()

◆ get_coefficients()

◆ get_operators()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ transpose()

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