gko::LinOp Class Reference

Inherits gko::PolymorphicObject.

Inherited by gko::matrix::Dense< value_type >, gko::BlockOperator, gko::Combination< ValueType >, gko::Composition< ValueType >, gko::experimental::distributed::Matrix< ValueType, LocalIndexType, GlobalIndexType >, gko::experimental::distributed::preconditioner::Schwarz< ValueType, LocalIndexType, GlobalIndexType >, gko::experimental::distributed::Vector< ValueType >, gko::experimental::factorization::Factorization< ValueType, IndexType >, gko::experimental::reorder::ScaledReordered< ValueType, IndexType >, gko::experimental::solver::Direct< ValueType, IndexType >, gko::ext::cuda::solver::Cudss< ValueType, IndexType >, gko::matrix::Coo< ValueType, IndexType >, gko::matrix::Csr< ValueType, IndexType >, gko::matrix::Dense< ValueType >, gko::matrix::Diagonal< ValueType >, gko::matrix::Ell< ValueType, IndexType >, gko::matrix::Fbcsr< ValueType, IndexType >, gko::matrix::Fft, gko::matrix::Fft2, gko::matrix::Fft3, gko::matrix::Hybrid< ValueType, IndexType >, gko::matrix::Identity< ValueType >, gko::matrix::Permutation< IndexType >, gko::matrix::RowGatherer< IndexType >, gko::matrix::ScaledPermutation< ValueType, IndexType >, gko::matrix::Sellp< ValueType, IndexType >, gko::matrix::SparsityCsr< ValueType, IndexType >, gko::multigrid::FixedCoarsening< ValueType, IndexType >, gko::multigrid::Pgm< ValueType, IndexType >, gko::multigrid::Rs< ValueType, IndexType >, gko::Perturbation< ValueType >, gko::preconditioner::Ic< ValueType, IndexType >, gko::preconditioner::Ilu< ValueType, ReverseApply, IndexType >, gko::preconditioner::Isai< IsaiType, ValueType, IndexType >, gko::preconditioner::Jacobi< ValueType, IndexType >, gko::solver::Bicg< ValueType >, gko::solver::Bicgstab< ValueType >, gko::solver::CbGmres< 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< ValueType, IndexType >, gko::solver::Minres< ValueType >, gko::solver::Multigrid, gko::solver::PipeCg< ValueType >, and gko::solver::UpperTrs< ValueType, IndexType >.

Collaboration diagram for gko::LinOp:

Public Member Functions
void	apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const
	Applies a linear operator to a vector (or a sequence of vectors). More...
void	apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< 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...
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::PolymorphicObject
PolymorphicObject &	operator= (const PolymorphicObject &)
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/2]

void gko::LinOp::apply ( ptr_param< const LinOp >  alpha, ptr_param< const LinOp >  b, ptr_param< const LinOp >  beta, ptr_param< 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)

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

apply() [2/2]

void gko::LinOp::apply ( ptr_param< const LinOp >  b, ptr_param< 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

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::Multigrid, gko::solver::Ir< ValueType >, gko::solver::Gmres< ValueType >, gko::experimental::distributed::preconditioner::Schwarz< ValueType, LocalIndexType, GlobalIndexType >, gko::solver::Chebyshev< ValueType >, gko::solver::PipeCg< ValueType >, gko::solver::Idr< ValueType >, gko::solver::Minres< 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::matrix::Fbcsr< ValueType, IndexType >::get_num_block_cols(), and gko::matrix::Fbcsr< ValueType, IndexType >::get_num_block_rows().

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