Ginkgo  Generated from pipelines/130473384 branch based on develop. Ginkgo version 1.1.1
A numerical linear algebra library targeting many-core architectures
Public Member Functions | List of all members
gko::LinOp Class Referenceabstract
Collaboration diagram for gko::LinOp:
[legend]

Public Member Functions

LinOpapply (const LinOp *b, LinOp *x)
 Applies a linear operator to a vector (or a sequence of vectors). More...
 
const LinOpapply (const LinOp *b, LinOp *x) const
 Applies a linear operator to a vector (or a sequence of vectors). More...
 
LinOpapply (const LinOp *alpha, const LinOp *b, const LinOp *beta, LinOp *x)
 Performs the operation x = alpha * op(b) + beta * x. More...
 
const LinOpapply (const LinOp *alpha, const LinOp *b, const LinOp *beta, LinOp *x) const
 Performs the operation x = alpha * op(b) + beta * x. More...
 
const dim< 2 > & get_size () const noexcept
 Returns the size of the operator. More...
 
- 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)
 
LinOpcopy_from (std::unique_ptr< 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. More...
 
std::unique_ptr< PolymorphicObjectcreate_default () const
 Creates a new "default" object of the same dynamic type as this object. More...
 
std::unique_ptr< PolymorphicObjectclone (std::shared_ptr< const Executor > exec) const
 Creates a clone of the object. More...
 
std::unique_ptr< PolymorphicObjectclone () const
 Creates a clone of the object. More...
 
PolymorphicObjectcopy_from (const PolymorphicObject *other)
 Copies another object into this object. More...
 
PolymorphicObjectcopy_from (std::unique_ptr< PolymorphicObject > other)
 Moves another object into this object. More...
 
PolymorphicObjectclear ()
 Transforms the object into its default state. More...
 
std::shared_ptr< const Executorget_executor () const noexcept
 Returns the Executor of the object. More...
 
- 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. More...
 
void remove_logger (const Logger *logger) override
 Removes a logger from the list of subscribed loggers. More...
 

Member Function Documentation

◆ apply() [1/4]

LinOp* gko::LinOp::apply ( const LinOp alpha,
const LinOp b,
const LinOp beta,
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::PolymorphicObject::get_executor(), and gko::make_temporary_clone().

◆ apply() [2/4]

const LinOp* gko::LinOp::apply ( const LinOp alpha,
const LinOp b,
const LinOp beta,
LinOp x 
) const
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::PolymorphicObject::get_executor(), and gko::make_temporary_clone().

◆ apply() [3/4]

LinOp* gko::LinOp::apply ( const LinOp b,
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::PolymorphicObject::get_executor(), and gko::make_temporary_clone().

◆ apply() [4/4]

const LinOp* gko::LinOp::apply ( const LinOp b,
LinOp x 
) const
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::PolymorphicObject::get_executor(), and gko::make_temporary_clone().

◆ get_size()

const dim<2>& gko::LinOp::get_size ( ) const
inlinenoexcept

Returns the size of the operator.

Returns
size of the operator

Referenced by gko::matrix::Dense< ValueType >::create_submatrix().


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