gko::Composition< ValueType > Class Template Reference

The Composition class can be used to compose linear operators op1, op2, ..., opn and obtain the operator op1 * op2 * ... More...

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

Inheritance diagram for gko::Composition< ValueType >:

Collaboration diagram for gko::Composition< ValueType >:

Public Types
using	value_type = ValueType
using	transposed_type = Composition< ValueType >

Public Member Functions
const std::vector< std::shared_ptr< const LinOp > > &	get_operators () const noexcept
	Returns a list of operators of the composition. 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...
Composition &	operator= (const Composition &)
	Copy-assigns a Composition. More...
Composition &	operator= (Composition &&)
	Move-assigns a Composition. More...
	Composition (const Composition &)
	Copy-constructs a Composition. More...
	Composition (Composition &&)
	Move-constructs a Composition. More...
Public Member Functions inherited from gko::LinOp
void	apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const
	Applies a linear operator to a vector (or a sequence of vectors). More...
void	apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x) const
	Performs the operation x = alpha * op(b) + beta * x. More...
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::PolymorphicObject
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)

Friends
class	EnableCreateMethod< Composition >

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

Detailed Description

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

The Composition class can be used to compose linear operators op1, op2, ..., opn and obtain the operator op1 * op2 * ...

• opn.

All LinOps of the Composition must operate on Dense inputs. For an operator op_k that require an initial guess for their apply, Composition provides either

• the output of the previous op_{k+1}->apply if op_k has square dimension
• zero if op_k is rectangular as an initial guess.

Composition 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

Composition() [1/2]

template<typename ValueType = default_precision>

gko::Composition< ValueType >::Composition

(

const Composition< ValueType > &

)

Copy-constructs a Composition.

This inherits the executor of the input Composition and all of its operators with shared ownership.

Composition() [2/2]

template<typename ValueType = default_precision>

gko::Composition< ValueType >::Composition

(

Composition< ValueType > &&

)

Move-constructs a Composition.

This inherits the executor of the input Composition 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::Composition< 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_operators()

template<typename ValueType = default_precision>

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

inlinenoexcept

Returns a list of operators of the composition.

Returns

a list of operators

operator=() [1/2]

template<typename ValueType = default_precision>

Composition& gko::Composition< ValueType >::operator=

(

Composition< ValueType > &&

)

Move-assigns a Composition.

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>

Composition& gko::Composition< ValueType >::operator=

(

const Composition< ValueType > &

)

Copy-assigns a Composition.

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::Composition< 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/composition.hpp