![]() |
Ginkgo Generated from branch based on main. Ginkgo version 1.10.0
A numerical linear algebra library targeting many-core architectures
|
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>
Inherits gko::EnablePolymorphicObject< ConcreteLinOp, LinOp >, and gko::EnablePolymorphicAssignment< ConcreteLinOp >.
Inherited by gko::Combination< ValueType >, gko::Composition< ValueType >, gko::Composition< value_type >, gko::experimental::distributed::Vector< ValueType >, gko::experimental::distributed::Vector< to_complex< value_type > >, gko::experimental::distributed::Vector< previous_precision< ValueType > >, gko::experimental::factorization::Factorization< value_type, index_type >, gko::matrix::Coo< ValueType, IndexType >, gko::matrix::Csr< value_type, index_type >, gko::matrix::Csr< ValueType, IndexType >, gko::matrix::Dense< ValueType >, gko::matrix::Dense< value_type >, gko::matrix::Dense< to_complex< ValueType > >, gko::matrix::Dense< absolute_type >, gko::matrix::Dense< remove_complex< ValueType > >, gko::matrix::Diagonal< ValueType >, gko::matrix::Ell< value_type, index_type >, gko::matrix::Ell< ValueType, IndexType >, gko::matrix::Fbcsr< ValueType, IndexType >, gko::matrix::Identity< ValueType >, gko::matrix::Permutation< index_type >, gko::matrix::Permutation< IndexType >, gko::matrix::SparsityCsr< value_type, index_type >, gko::matrix::SparsityCsr< IndexType, ValueType >, gko::matrix::SparsityCsr< ValueType, IndexType >, gko::preconditioner::Ic< LSolverTypeOrValueType, IndexType >, , gko::preconditioner::Jacobi< ValueType, IndexType >, gko::solver::Bicg< ValueType >, gko::solver::Bicgstab< ValueType >, gko::solver::Cg< ValueType >, gko::solver::Cgs< ValueType >, gko::solver::Chebyshev< ValueType >, gko::solver::Fcg< ValueType >, gko::solver::Gcr< ValueType >, gko::solver::Gmres< ValueType >, gko::solver::Idr< ValueType >, gko::solver::Ir< ValueType >, gko::solver::LowerTrs< value_type, index_type >, gko::solver::LowerTrs< ValueType, IndexType >, gko::solver::Minres< ValueType >, gko::solver::PipeCg< ValueType >, and gko::solver::UpperTrs< value_type, index_type >.
Public Member Functions | |
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) |
Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< ConcreteLinOp, LinOp > | |
std::unique_ptr< ConcreteLinOp > | create_default (std::shared_ptr< const Executor > exec) const |
std::unique_ptr< ConcreteLinOp > | clone (std::shared_ptr< const Executor > exec) const |
ConcreteLinOp * | copy_from (const PolymorphicObject *other) |
ConcreteLinOp * | move_from (ptr_param< PolymorphicObject > other) |
ConcreteLinOp * | 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). | |
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. | |
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. | |
virtual bool | apply_uses_initial_guess () const |
Returns true if the linear operator uses the data given in x as an initial guess. | |
LinOp & | operator= (const LinOp &)=default |
Copy-assigns a LinOp. | |
LinOp & | operator= (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< LinOp > | create_default (std::shared_ptr< const Executor > exec) const |
std::unique_ptr< LinOp > | clone (std::shared_ptr< const Executor > exec) const |
LinOp * | copy_from (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. | |
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. | |
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< ConcreteLinOp > | |
void | convert_to (result_type *result) const override |
void | move_to (result_type *result) override |
Additional Inherited Members | |
Public Types inherited from gko::EnablePolymorphicAssignment< ConcreteLinOp > | |
using | result_type |
Public Types inherited from gko::ConvertibleTo< ConcreteLinOp > | |
using | result_type |
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: