Ginkgo  Generated from pipelines/224724463 branch based on develop. Ginkgo version 1.3.0
A numerical linear algebra library targeting many-core architectures
Public Member Functions | List of all members
gko::EnableLinOp< ConcreteLinOp, PolymorphicBase > Class Template Reference

The EnableLinOp mixin can be used to provide sensible default implementations of the majority of the LinOp and PolymorphicObject interface. More...

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

Collaboration diagram for gko::EnableLinOp< ConcreteLinOp, PolymorphicBase >:
[legend]

Public Member Functions

const ConcreteLinOp * apply (const LinOp *b, LinOp *x) const
 
ConcreteLinOp * apply (const LinOp *b, LinOp *x)
 
const ConcreteLinOp * apply (const LinOp *alpha, const LinOp *b, const LinOp *beta, LinOp *x) const
 
ConcreteLinOp * apply (const LinOp *alpha, const LinOp *b, const LinOp *beta, LinOp *x)
 
- Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< ConcreteLinOp, PolymorphicBase >
std::unique_ptr< ConcreteLinOp > create_default (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< ConcreteLinOp > create_default () const
 
std::unique_ptr< ConcreteLinOp > clone (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< ConcreteLinOp > clone () const
 
ConcreteLinOp * copy_from (const PolymorphicObject *other)
 
ConcreteLinOp * copy_from (std::unique_ptr< PolymorphicObject > other)
 
ConcreteLinOp * clear ()
 
- Public Member Functions inherited from gko::EnablePolymorphicAssignment< ConcreteLinOp >
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...
 

Additional Inherited Members

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

Detailed Description

template<typename ConcreteLinOp, typename PolymorphicBase = LinOp>
class gko::EnableLinOp< ConcreteLinOp, PolymorphicBase >

The EnableLinOp mixin can be used to provide sensible default implementations of the majority of the LinOp and PolymorphicObject interface.

The goal of the mixin is to facilitate the development of new LinOp, by enabling the implementers to focus on the important parts of their operator, while the library takes care of generating the trivial utility functions. The mixin will provide default implementations for the entire PolymorphicObject interface, including a default implementation of copy_from between objects of the new LinOp type. It will also hide the default LinOp::apply() methods with versions that preserve the static type of the object.

Implementers of new LinOps are required to specify only the following aspects:

  1. Creation of the LinOp: This can be facilitated via either EnableCreateMethod mixin (used mostly for matrix formats), or GKO_ENABLE_LIN_OP_FACTORY macro (used for operators created from other operators, like preconditioners and solvers).
  2. Application of the LinOp: Implementers have to override the two overloads of the LinOp::apply_impl() virtual methods.
Template Parameters
ConcreteLinOpthe concrete LinOp which is being implemented [CRTP parameter]
PolymorphicBaseparent of ConcreteLinOp in the polymorphic hierarchy, has to be a subclass of LinOp

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