Ginkgo Generated from branch based on main. Ginkgo version 1.10.0
A numerical linear algebra library targeting many-core architectures
Loading...
Searching...
No Matches
gko::Combination< ValueType > Class Template Reference

The Combination class can be used to construct a linear combination of multiple linear operators c1 * op1 + c2 * op2 + ... + ck * opk. 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< default_precision > >
using result_type
Public Types inherited from gko::ConvertibleTo< Combination< default_precision > >
using result_type

Public Member Functions

const std::vector< std::shared_ptr< const LinOp > > & get_coefficients () const noexcept
 Returns a list of coefficients of the combination.
const std::vector< std::shared_ptr< const LinOp > > & get_operators () const noexcept
 Returns a list of operators of the combination.
std::unique_ptr< LinOptranspose () const override
 Returns a LinOp representing the transpose of the Transposable object.
std::unique_ptr< LinOpconj_transpose () const override
 Returns a LinOp representing the conjugate transpose of the Transposable object.
Combinationoperator= (const Combination &)
 Copy-assigns a Combination.
Combinationoperator= (Combination &&)
 Move-assigns a Combination.
 Combination (const Combination &)
 Copy-constructs a Combination.
 Combination (Combination &&)
 Move-constructs a Combination.
Public Member Functions inherited from gko::EnableLinOp< Combination< default_precision > >
const Combination< default_precision > * apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const
Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< Combination< default_precision >, LinOp >
std::unique_ptr< Combination< default_precision > > create_default (std::shared_ptr< const Executor > exec) const
std::unique_ptr< Combination< default_precision > > clone (std::shared_ptr< const Executor > exec) const
Combination< default_precision > * copy_from (const PolymorphicObject *other)
Combination< default_precision > * move_from (ptr_param< PolymorphicObject > other)
Combination< default_precision > * clear ()
Public Member Functions inherited from gko::LinOp
LinOpapply (ptr_param< const LinOp > b, ptr_param< LinOp > x)
 Applies a linear operator to a vector (or a sequence of vectors).
const LinOpapply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const
LinOpapply (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.
const LinOpapply (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.
virtual bool apply_uses_initial_guess () const
 Returns true if the linear operator uses the data given in x as an initial guess.
LinOpoperator= (const LinOp &)=default
 Copy-assigns a LinOp.
LinOpoperator= (LinOp &&other)
 Move-assigns a LinOp.
 LinOp (const LinOp &)=default
 Copy-constructs a LinOp.
 LinOp (LinOp &&other)
 Move-constructs a LinOp.
Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< LinOp >
std::unique_ptr< LinOpcreate_default (std::shared_ptr< const Executor > exec) const
std::unique_ptr< LinOpclone (std::shared_ptr< const Executor > exec) const
LinOpcopy_from (const PolymorphicObject *other)
LinOpmove_from (ptr_param< PolymorphicObject > other)
LinOpclear ()
Public Member Functions inherited from gko::PolymorphicObject
PolymorphicObjectoperator= (const PolymorphicObject &)
std::unique_ptr< PolymorphicObjectcreate_default (std::shared_ptr< const Executor > exec) const
 Creates a new "default" object of the same dynamic type as this object.
std::unique_ptr< PolymorphicObjectcreate_default () const
 Creates a new "default" object of the same dynamic type as this object.
std::unique_ptr< PolymorphicObjectclone (std::shared_ptr< const Executor > exec) const
 Creates a clone of the object.
std::unique_ptr< PolymorphicObjectclone () const
 Creates a clone of the object.
PolymorphicObjectcopy_from (const PolymorphicObject *other)
 Copies another object into this object.
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.
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.
PolymorphicObjectcopy_from (const std::shared_ptr< const PolymorphicObject > &other)
 Copies another object into this object.
PolymorphicObjectmove_from (ptr_param< PolymorphicObject > other)
 Moves another object into this object.
PolymorphicObjectclear ()
 Transforms the object into its default state.
std::shared_ptr< const Executorget_executor () const noexcept
 Returns the Executor of the object.
Public Member Functions inherited from gko::log::EnableLogging< PolymorphicObject >
void add_logger (std::shared_ptr< const Logger > logger) override
 Adds a new logger to the list of subscribed loggers.
void remove_logger (const Logger *logger) override
 Removes a logger from the list of subscribed loggers.
const std::vector< std::shared_ptr< const Logger > > & get_loggers () const override
 Returns the vector containing all loggers registered at this object.
void clear_loggers () override
 Remove all loggers registered at this object.
Public Member Functions inherited from gko::log::Loggable
void remove_logger (ptr_param< const Logger > logger)
Public Member Functions inherited from gko::EnablePolymorphicAssignment< Combination< default_precision > >
void convert_to (result_type *result) const override
void move_to (result_type *result) override

Friends

class EnablePolymorphicObject< Combination, LinOp >
class EnableCreateMethod< Combination >

Additional Inherited Members

Static Public Member Functions inherited from gko::EnableCreateMethod< Combination< default_precision > >
static std::unique_ptr< Combination< default_precision > > 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
ValueTypeprecision 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: