![]() |
Ginkgo Generated from branch based on master. Ginkgo version 1.7.0
A numerical linear algebra library targeting many-core architectures
|
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>
Public Types | |
using | value_type = ValueType |
using | transposed_type = Combination<ValueType> |
![]() | |
using | result_type |
![]() | |
using | result_type = ResultType |
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< LinOp > | transpose () const override |
Returns a LinOp representing the transpose of the Transposable object. | |
std::unique_ptr< LinOp > | conj_transpose () const override |
Returns a LinOp representing the conjugate transpose of the Transposable object. | |
Combination & | operator= (const Combination &) |
Copy-assigns a Combination. | |
Combination & | operator= (Combination &&) |
Move-assigns a Combination. | |
Combination (const Combination &) | |
Copy-constructs a Combination. | |
Combination (Combination &&) | |
Move-constructs a Combination. | |
![]() | |
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) |
![]() | |
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 () |
![]() | |
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. | |
std::unique_ptr< PolymorphicObject > | create_default () const |
Creates a new "default" object of the same dynamic type as this object. | |
std::unique_ptr< PolymorphicObject > | clone (std::shared_ptr< const Executor > exec) const |
Creates a clone of the object. | |
std::unique_ptr< PolymorphicObject > | clone () const |
Creates a clone of the object. | |
PolymorphicObject * | copy_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. | |
PolymorphicObject * | copy_from (const std::shared_ptr< const PolymorphicObject > &other) |
Copies another object into this object. | |
PolymorphicObject * | move_from (ptr_param< PolymorphicObject > other) |
Moves another object into this object. | |
PolymorphicObject * | clear () |
Transforms the object into its default state. | |
std::shared_ptr< const Executor > | get_executor () const noexcept |
Returns the Executor of the object. | |
![]() | |
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. | |
void | remove_logger (ptr_param< const Logger > logger) |
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. | |
![]() | |
void | remove_logger (ptr_param< const Logger > logger) |
![]() | |
void | convert_to (result_type *result) const override |
Converts the implementer to an object of type result_type. | |
void | move_to (result_type *result) override |
Converts the implementer to an object of type result_type by moving data from this object. | |
![]() | |
virtual void | convert_to (result_type *result) const =0 |
Converts the implementer to an object of type result_type. | |
void | convert_to (ptr_param< result_type > result) const |
virtual void | move_to (result_type *result)=0 |
Converts the implementer to an object of type result_type by moving data from this object. | |
void | move_to (ptr_param< result_type > result) |
Friends | |
class | EnablePolymorphicObject< Combination, LinOp > |
class | EnableCreateMethod< Combination > |
Additional Inherited Members | |
![]() | |
template<typename... Args> | |
static std::unique_ptr< ConcreteType > | create (Args &&... args) |
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.
ValueType | precision of input and result vectors |
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.
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.
|
overridevirtual |
Returns a LinOp representing the conjugate transpose of the Transposable object.
Implements gko::Transposable.
|
inlinenoexcept |
Returns a list of coefficients of the combination.
|
inlinenoexcept |
Returns a list of operators of the combination.
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.
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.
|
overridevirtual |
Returns a LinOp representing the transpose of the Transposable object.
Implements gko::Transposable.