Ginkgo Generated from branch based on master. Ginkgo version 1.8.0
A numerical linear algebra library targeting many-core architectures
Loading...
Searching...
No Matches
gko::LinOp Class Referenceabstract
Inheritance diagram for gko::LinOp:
[legend]
Collaboration diagram for gko::LinOp:
[legend]

Public Member Functions

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< LinOpcreate_default () const
 
std::unique_ptr< LinOpclone (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< LinOpclone () const
 
LinOpcopy_from (const PolymorphicObject *other)
 
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, LinOp > * copy_from (std::unique_ptr< Derived > &&other)
 
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, LinOp > * copy_from (const std::unique_ptr< Derived > &other)
 
LinOpcopy_from (const std::shared_ptr< 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.
 
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.
 
- Public Member Functions inherited from gko::log::Loggable
void remove_logger (ptr_param< const Logger > logger)
 

Constructor & Destructor Documentation

◆ LinOp() [1/2]

gko::LinOp::LinOp ( const LinOp & )
default

Copy-constructs a LinOp.

Inherits executor and size from the input.

◆ LinOp() [2/2]

gko::LinOp::LinOp ( LinOp && other)
inline

Move-constructs a LinOp.

Inherits executor and size from the input, which will have size 0x0 and unchanged executor afterwards.

Member Function Documentation

◆ apply() [1/4]

LinOp * gko::LinOp::apply ( ptr_param< const LinOp > alpha,
ptr_param< const LinOp > b,
ptr_param< const LinOp > beta,
ptr_param< LinOp > x )
inline

Performs the operation x = alpha * op(b) + beta * x.

Parameters
alphascaling of the result of op(b)
bvector(s) on which the operator is applied
betascaling of the input x
xoutput vector(s)
Returns
this

References gko::ptr_param< T >::get(), gko::PolymorphicObject::get_executor(), and gko::make_temporary_clone().

◆ apply() [2/4]

const LinOp * gko::LinOp::apply ( ptr_param< const LinOp > alpha,
ptr_param< const LinOp > b,
ptr_param< const LinOp > beta,
ptr_param< LinOp > x ) const
inline

◆ apply() [3/4]

LinOp * gko::LinOp::apply ( ptr_param< const LinOp > b,
ptr_param< LinOp > x )
inline

Applies a linear operator to a vector (or a sequence of vectors).

Performs the operation x = op(b), where op is this linear operator.

Parameters
bthe input vector(s) on which the operator is applied
xthe output vector(s) where the result is stored
Returns
this

References gko::ptr_param< T >::get(), gko::PolymorphicObject::get_executor(), and gko::make_temporary_clone().

◆ apply() [4/4]

const LinOp * gko::LinOp::apply ( ptr_param< const LinOp > b,
ptr_param< LinOp > x ) const
inline

◆ apply_uses_initial_guess()

virtual bool gko::LinOp::apply_uses_initial_guess ( ) const
inlinevirtual

Returns true if the linear operator uses the data given in x as an initial guess.

Returns false otherwise.

Returns
true if the linear operator uses the data given in x as an initial guess. Returns false otherwise.

Reimplemented in gko::solver::Bicg< ValueType >, gko::solver::Bicgstab< ValueType >, gko::solver::Cg< ValueType >, gko::solver::Cgs< ValueType >, gko::solver::Fcg< ValueType >, gko::solver::Gcr< ValueType >, gko::solver::Gmres< ValueType >, gko::solver::Idr< ValueType >, gko::solver::Ir< ValueType >, and gko::solver::Multigrid.

◆ get_size()

◆ operator=() [1/2]

◆ operator=() [2/2]

LinOp & gko::LinOp::operator= ( LinOp && other)
inline

Move-assigns a LinOp.

Preserves the executor and moves the size. The moved-from object has size 0x0 afterwards, but its executor is unchanged.


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