Inheritance diagram for gko::LinOp:

Collaboration diagram for gko::LinOp:

Public Member Functions
LinOp *	apply (ptr_param< const LinOp > b, ptr_param< LinOp > x)
	Applies a linear operator to a vector (or a sequence of vectors). More...

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. More...

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. More...

virtual bool	apply_uses_initial_guess () const
	Returns true if the linear operator uses the data given in x as an initial guess. More...

LinOp &	operator= (const LinOp &)=default
	Copy-assigns a LinOp. More...

LinOp &	operator= (LinOp &&other)
	Move-assigns a LinOp. More...

	LinOp (const LinOp &)=default
	Copy-constructs a LinOp. More...

	LinOp (LinOp &&other)
	Move-constructs a LinOp. 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)

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)

LinOp *	copy_from (const std::shared_ptr< 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. 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...

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. More...

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. More...

PolymorphicObject *	copy_from (const std::shared_ptr< const PolymorphicObject > &other)
	Copies another object into this object. More...

PolymorphicObject *	move_from (ptr_param< 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

void	remove_logger (const Logger *logger) override

void	remove_logger (ptr_param< const Logger > logger)

const std::vector< std::shared_ptr< const Logger > > &	get_loggers () const override

void	clear_loggers () override

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

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::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

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

◆ 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

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::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

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

◆ 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::Ir< ValueType >, gko::solver::Gmres< ValueType >, gko::experimental::distributed::preconditioner::Schwarz< ValueType, LocalIndexType, GlobalIndexType >, gko::solver::Idr< ValueType >, gko::solver::Bicg< ValueType >, gko::solver::Bicgstab< ValueType >, gko::solver::Fcg< ValueType >, gko::solver::Gcr< ValueType >, gko::solver::Cg< ValueType >, and gko::solver::Cgs< ValueType >.

◆ 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::preconditioner::Ic< LSolverType, IndexType >::conj_transpose(), gko::preconditioner::Ilu< LSolverType, USolverType, ReverseApply, IndexType >::conj_transpose(), gko::matrix::Fbcsr< ValueType, IndexType >::get_num_block_cols(), gko::matrix::Fbcsr< ValueType, IndexType >::get_num_block_rows(), gko::preconditioner::Ic< LSolverType, IndexType >::transpose(), and gko::preconditioner::Ilu< LSolverType, USolverType, ReverseApply, IndexType >::transpose().

◆ operator=() [1/2]

LinOp& gko::LinOp::operator= ( const LinOp & )

default

Copy-assigns a LinOp.

Preserves the executor and copies the size.

◆ 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:

ginkgo/core/base/lin_op.hpp

Public Member Functions

Constructor & Destructor Documentation

◆ LinOp() [1/2]

◆ LinOp() [2/2]

Member Function Documentation

◆ apply() [1/4]

◆ apply() [2/4]

◆ apply() [3/4]

◆ apply() [4/4]

◆ apply_uses_initial_guess()

◆ get_size()

◆ operator=() [1/2]

◆ operator=() [2/2]