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>

Inheritance diagram for gko::Perturbation< ValueType >:

[legend]

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 LinOp >	get_basis () const noexcept
	Returns the basis of the perturbation. More...

const std::shared_ptr< const LinOp >	get_projector () const noexcept
	Returns the projector of the perturbation. More...

const std::shared_ptr< const LinOp >	get_scalar () const noexcept
	Returns the scalar of the perturbation. More...

Perturbation &	operator= (const Perturbation &other)

Perturbation &	operator= (Perturbation &&other)

	Perturbation (const Perturbation &other)

	Perturbation (Perturbation &&other)

Public Member Functions inherited from gko::EnableLinOp< Perturbation< ValueType > >
const Perturbation< ValueType > *	apply (ptr_param< const LinOp > b, ptr_param< LinOp > x) const

Perturbation< ValueType > *	apply (ptr_param< const LinOp > b, ptr_param< LinOp > x)

const Perturbation< ValueType > *	apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< LinOp > x) const

Perturbation< ValueType > *	apply (ptr_param< const LinOp > alpha, ptr_param< const LinOp > b, ptr_param< const LinOp > beta, ptr_param< 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)

std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, Perturbation< ValueType > > *	copy_from (std::unique_ptr< Derived > &&other)

std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, Perturbation< ValueType > > *	copy_from (const std::unique_ptr< Derived > &other)

Perturbation< ValueType > *	copy_from (const std::shared_ptr< const PolymorphicObject > &other)

Perturbation< ValueType > *	move_from (ptr_param< PolymorphicObject > other)

Perturbation< ValueType > *	clear ()

Public Member Functions inherited from gko::LinOp
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)

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

Public Member Functions inherited from gko::ConvertibleTo< Perturbation< ValueType > >
void	convert_to (ptr_param< result_type > result) const

void	move_to (ptr_param< result_type > result)

Static Public Member Functions
static std::unique_ptr< Perturbation >	create (std::shared_ptr< const Executor > exec)
	Creates an empty perturbation operator (0x0 operator). More...

static std::unique_ptr< Perturbation >	create (std::shared_ptr< const LinOp > scalar, std::shared_ptr< const LinOp > basis)
	Creates a perturbation with scalar and basis by setting projector to the conjugate transpose of basis. More...

static std::unique_ptr< Perturbation >	create (std::shared_ptr< const LinOp > scalar, std::shared_ptr< const LinOp > basis, std::shared_ptr< const LinOp > projector)
	Creates a perturbation of scalar, basis and projector. More...

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

Friends
class	EnablePolymorphicObject< Perturbation, LinOp >

class	EnableCreateMethod< Perturbation >

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

ValueType precision of input and result vectors

Note: the apply operations of Perturbation class are not thread safe

Member Function Documentation

◆ create() [1/3]

template<typename ValueType = default_precision>

static std::unique_ptr<Perturbation> gko::Perturbation< ValueType >::create ( std::shared_ptr< const Executor > exec )

static

Creates an empty perturbation operator (0x0 operator).

Parameters

exec	Executor associated to the perturbation

Returns: A smart pointer to the newly created perturbation.

◆ create() [2/3]

template<typename ValueType = default_precision>

static std::unique_ptr<Perturbation> gko::Perturbation< ValueType >::create	(	std::shared_ptr< const LinOp >	scalar,
		std::shared_ptr< const LinOp >	basis
	)

static

Creates a perturbation with scalar and basis by setting projector to the conjugate transpose of basis.

Basis must be transposable. Perturbation will throw gko::NotSupported if basis is not transposable.

Parameters

scalar	scaling of the movement
basis	the direction basis

Returns: A smart pointer to the newly created perturbation.

◆ create() [3/3]

template<typename ValueType = default_precision>

static std::unique_ptr<Perturbation> gko::Perturbation< ValueType >::create	(	std::shared_ptr< const LinOp >	scalar,
		std::shared_ptr< const LinOp >	basis,
		std::shared_ptr< const LinOp >	projector
	)

static

Creates a perturbation of scalar, basis and projector.

Parameters

scalar	scaling of the movement
basis	the direction basis
projector	decides the coefficient of basis

Returns: A smart pointer to the newly created perturbation.

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

ginkgo/core/base/perturbation.hpp

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

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

Member Function Documentation

◆ create() [1/3]

◆ create() [2/3]

◆ create() [3/3]

◆ get_basis()

◆ get_projector()

◆ get_scalar()

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