Ginkgo  Generated from pipelines/130473384 branch based on develop. Ginkgo version 1.1.1
A numerical linear algebra library targeting many-core architectures
Classes | Public Types | Public Member Functions | Friends | List of all members
gko::Perturbation< ValueType > Class Template Reference

The Perturbation class can be used to construct a LinOp to represent the operation (identity + scalar * basis * projector). More...

#include <ginkgo/core/base/perturbation.hpp>

Collaboration diagram for gko::Perturbation< ValueType >:
[legend]

Public Types

using value_type = ValueType
 
- Public Types inherited from gko::EnablePolymorphicAssignment< Perturbation< ValueType > >
using result_type = Perturbation< ValueType >
 
- Public Types inherited from gko::ConvertibleTo< Perturbation< ValueType > >
using result_type = Perturbation< ValueType >
 

Public Member Functions

const std::shared_ptr< const LinOpget_basis () const noexcept
 Returns the basis of the perturbation. More...
 
const std::shared_ptr< const LinOpget_projector () const noexcept
 Returns the projector of the perturbation. More...
 
const std::shared_ptr< const LinOpget_scalar () const noexcept
 Returns the scalar of the perturbation. More...
 
- Public Member Functions inherited from gko::EnableLinOp< Perturbation< ValueType > >
const Perturbation< ValueType > * apply (const LinOp *b, LinOp *x) const
 
Perturbation< ValueType > * apply (const LinOp *b, LinOp *x)
 
const Perturbation< ValueType > * apply (const LinOp *alpha, const LinOp *b, const LinOp *beta, LinOp *x) const
 
Perturbation< ValueType > * apply (const LinOp *alpha, const LinOp *b, const LinOp *beta, LinOp *x)
 
- Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< Perturbation< ValueType >, LinOp >
std::unique_ptr< Perturbation< ValueType > > create_default (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< Perturbation< ValueType > > create_default () const
 
std::unique_ptr< Perturbation< ValueType > > clone (std::shared_ptr< const Executor > exec) const
 
std::unique_ptr< Perturbation< ValueType > > clone () const
 
Perturbation< ValueType > * copy_from (const PolymorphicObject *other)
 
Perturbation< ValueType > * copy_from (std::unique_ptr< PolymorphicObject > other)
 
Perturbation< ValueType > * clear ()
 
- Public Member Functions inherited from gko::LinOp
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...
 
- Public Member Functions inherited from gko::EnablePolymorphicAssignment< Perturbation< ValueType > >
void convert_to (result_type *result) const override
 Converts the implementer to an object of type result_type. More...
 
void move_to (result_type *result) override
 Converts the implementer to an object of type result_type by moving data from this object. More...
 

Friends

class EnablePolymorphicObject< Perturbation, LinOp >
 
class EnableCreateMethod< Perturbation >
 

Additional Inherited Members

- Static Public Member Functions inherited from gko::EnableCreateMethod< Perturbation< ValueType > >
static std::unique_ptr< Perturbation< ValueType > > create (Args &&... args)
 

Detailed Description

template<typename ValueType = default_precision>
class gko::Perturbation< ValueType >

The Perturbation class can be used to construct a LinOp to represent the operation (identity + scalar * basis * projector).

This operator adds a movement along a direction constructed by basis and projector on the LinOp. projector gives the coefficient of basis to decide the direction.

For example, the Householder matrix can be represented with the Perturbation operator as follows. If u is the Householder factor then we can generate the Householder transformation, H = (I - 2 u u*). In this case, the parameters of Perturbation class are scalar = -2, basis = u, and projector = u*.

Template Parameters
ValueTypeprecision of input and result vectors
Note
the apply operations of Perturbation class are not thread safe

Member Function Documentation

◆ get_basis()

template<typename ValueType = default_precision>
const std::shared_ptr<const LinOp> gko::Perturbation< ValueType >::get_basis ( ) const
inlinenoexcept

Returns the basis of the perturbation.

Returns
the basis of the perturbation

◆ get_projector()

template<typename ValueType = default_precision>
const std::shared_ptr<const LinOp> gko::Perturbation< ValueType >::get_projector ( ) const
inlinenoexcept

Returns the projector of the perturbation.

Returns
the projector of the perturbation

◆ get_scalar()

template<typename ValueType = default_precision>
const std::shared_ptr<const LinOp> gko::Perturbation< ValueType >::get_scalar ( ) const
inlinenoexcept

Returns the scalar of the perturbation.

Returns
the scalar of the perturbation

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