gko::LinOp Class Reference

Collaboration diagram for gko::LinOp:

Public Member Functions
LinOp *	apply (const LinOp *b, LinOp *x)
	Applies a linear operator to a vector (or a sequence of vectors). More...
const LinOp *	apply (const LinOp *b, LinOp *x) const
	Applies a linear operator to a vector (or a sequence of vectors). More...
LinOp *	apply (const LinOp *alpha, const LinOp *b, const LinOp *beta, LinOp *x)
	Performs the operation x = alpha * op(b) + beta * x. More...
const LinOp *	apply (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< LinOp >	create_default (std::shared_ptr< const Executor > exec) const
std::unique_ptr< LinOp >	create_default () const
std::unique_ptr< LinOp >	clone (std::shared_ptr< const Executor > exec) const
std::unique_ptr< LinOp >	clone () const
LinOp *	copy_from (const PolymorphicObject *other)
LinOp *	copy_from (std::unique_ptr< 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. More...
std::unique_ptr< PolymorphicObject >	create_default () const
	Creates a new "default" object of the same dynamic type as this object. More...
std::unique_ptr< PolymorphicObject >	clone (std::shared_ptr< const Executor > exec) const
	Creates a clone of the object. More...
std::unique_ptr< PolymorphicObject >	clone () const
	Creates a clone of the object. More...
PolymorphicObject *	copy_from (const PolymorphicObject *other)
	Copies another object into this object. More...
PolymorphicObject *	copy_from (std::unique_ptr< PolymorphicObject > other)
	Moves another object into this object. More...
PolymorphicObject *	clear ()
	Transforms the object into its default state. More...
std::shared_ptr< const Executor >	get_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 *  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

b	the input vector(s) on which the operator is applied
x	the output vector(s) where the result is stored

Returns

this

References gko::PolymorphicObject::get_executor(), and gko::make_temporary_clone().

apply() [2/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

b	the input vector(s) on which the operator is applied
x	the output vector(s) where the result is stored

Returns

this

References gko::PolymorphicObject::get_executor(), and gko::make_temporary_clone().

apply() [3/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

alpha	scaling of the result of op(b)
b	vector(s) on which the operator is applied
beta	scaling of the input x
x	output vector(s)

Returns

this

References gko::PolymorphicObject::get_executor(), and gko::make_temporary_clone().

apply() [4/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

alpha	scaling of the result of op(b)
b	vector(s) on which the operator is applied
beta	scaling of the input x
x	output vector(s)

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(), gko::Combination< ValueType >::get_operators(), and gko::matrix::Csr< ValueType, IndexType >::get_strategy().

---

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

• ginkgo/core/base/lin_op.hpp (fb72cdf1)