#include <ginkgo/core/matrix/batch_identity.hpp>

Inheritance diagram for gko::batch::matrix::Identity< ValueType >:

Public Types
using	value_type = ValueType

using	index_type = int32

using	unbatch_type = gko::matrix::Identity< ValueType >

using	absolute_type = remove_complex< Identity >

using	complex_type = to_complex< Identity >

Public Types inherited from gko::EnablePolymorphicAssignment< ConcreteBatchLinOp >
using	result_type = ConcreteBatchLinOp

Public Types inherited from gko::ConvertibleTo< ResultType >
using	result_type = ResultType

Public Member Functions
Identity *	apply (ptr_param< const MultiVector< value_type > > b, ptr_param< MultiVector< value_type > > x)

Identity *	apply (ptr_param< const MultiVector< value_type > > alpha, ptr_param< const MultiVector< value_type > > b, ptr_param< const MultiVector< value_type > > beta, ptr_param< MultiVector< value_type > > x)

const Identity *	apply (ptr_param< const MultiVector< value_type > > b, ptr_param< MultiVector< value_type > > x) const

const Identity *	apply (ptr_param< const MultiVector< value_type > > alpha, ptr_param< const MultiVector< value_type > > b, ptr_param< const MultiVector< value_type > > beta, ptr_param< MultiVector< value_type > > x) const

Public Member Functions inherited from gko::EnableAbstractPolymorphicObject< AbstractObject, PolymorphicBase >
std::unique_ptr< AbstractObject >	create_default (std::shared_ptr< const Executor > exec) const

std::unique_ptr< AbstractObject >	create_default () const

std::unique_ptr< AbstractObject >	clone (std::shared_ptr< const Executor > exec) const

std::unique_ptr< AbstractObject >	clone () const

AbstractObject *	copy_from (const PolymorphicObject *other)

template<typename Derived >
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, AbstractObject > *	copy_from (std::unique_ptr< Derived > &&other)

template<typename Derived >
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, AbstractObject > *	copy_from (const std::unique_ptr< Derived > &other)

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

AbstractObject *	move_from (ptr_param< PolymorphicObject > other)

AbstractObject *	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

std::unique_ptr< PolymorphicObject >	create_default () const

std::unique_ptr< PolymorphicObject >	clone (std::shared_ptr< const Executor > exec) const

std::unique_ptr< PolymorphicObject >	clone () const

PolymorphicObject *	copy_from (const PolymorphicObject *other)

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)

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)

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

PolymorphicObject *	move_from (ptr_param< PolymorphicObject > other)

PolymorphicObject *	clear ()

std::shared_ptr< const Executor >	get_executor () const noexcept

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< ConcreteBatchLinOp >
void	convert_to (result_type *result) const override

void	move_to (result_type *result) override

Public Member Functions inherited from gko::ConvertibleTo< ResultType >
virtual void	convert_to (result_type *result) const =0

void	convert_to (ptr_param< result_type > result) const

virtual void	move_to (result_type *result)=0

void	move_to (ptr_param< result_type > result)

Static Public Member Functions
static std::unique_ptr< Identity >	create (std::shared_ptr< const Executor > exec, const batch_dim< 2 > &size=batch_dim< 2 >{})

Friends
class	EnablePolymorphicObject< Identity, BatchLinOp >

Additional Inherited Members
Protected Member Functions inherited from gko::EnablePolymorphicObject< ConcreteObject, PolymorphicBase >
std::unique_ptr< PolymorphicObject >	create_default_impl (std::shared_ptr< const Executor > exec) const override

PolymorphicObject *	copy_from_impl (const PolymorphicObject *other) override

PolymorphicObject *	copy_from_impl (std::unique_ptr< PolymorphicObject > other) override

PolymorphicObject *	move_from_impl (PolymorphicObject *other) override

PolymorphicObject *	move_from_impl (std::unique_ptr< PolymorphicObject > other) override

PolymorphicObject *	clear_impl () override

Protected Member Functions inherited from gko::PolymorphicObject
	PolymorphicObject (std::shared_ptr< const Executor > exec)

	PolymorphicObject (const PolymorphicObject &other)

Protected Member Functions inherited from gko::log::EnableLogging< PolymorphicObject >
void	log (Params &&... params) const

Protected Attributes inherited from gko::log::EnableLogging< PolymorphicObject >
std::vector< std::shared_ptr< const Logger > >	loggers_

Detailed Description

template<typename ValueType = default_precision>
class gko::batch::matrix::Identity< ValueType >

The batch Identity matrix, which represents a batch of Identity matrices.

Template Parameters

ValueType precision of matrix elements

Member Function Documentation

◆ apply() [1/4]

template<typename ValueType = default_precision>

Identity * gko::batch::matrix::Identity< ValueType >::apply	(	ptr_param< const MultiVector< value_type > >	alpha,
		ptr_param< const MultiVector< value_type > >	b,
		ptr_param< const MultiVector< value_type > >	beta,
		ptr_param< MultiVector< value_type > >	x
	)

Apply the matrix to a multi-vector with a linear combination of the given input vector. Represents the matrix vector multiplication, x = alpha * I

b + beta * x, where x and b are both multi-vectors.

Parameters

alpha	the scalar to scale the matrix-vector product with
b	the multi-vector to be applied to
beta	the scalar to scale the x vector with
x	the output multi-vector

◆ apply() [2/4]

template<typename ValueType = default_precision>

const Identity * gko::batch::matrix::Identity< ValueType >::apply	(	ptr_param< const MultiVector< value_type > >	alpha,
		ptr_param< const MultiVector< value_type > >	b,
		ptr_param< const MultiVector< value_type > >	beta,
		ptr_param< MultiVector< value_type > >	x
	)		const

◆ apply() [3/4]

template<typename ValueType = default_precision>

Identity * gko::batch::matrix::Identity< ValueType >::apply	(	ptr_param< const MultiVector< value_type > >	b,
		ptr_param< MultiVector< value_type > >	x
	)

Apply the matrix to a multi-vector. Represents the matrix vector multiplication, x = I * b, where x and b are both multi-vectors.

Parameters

b	the multi-vector to be applied to
x	the output multi-vector

◆ apply() [4/4]

template<typename ValueType = default_precision>

const Identity * gko::batch::matrix::Identity< ValueType >::apply	(	ptr_param< const MultiVector< value_type > >	b,
		ptr_param< MultiVector< value_type > >	x
	)		const

◆ create()

template<typename ValueType = default_precision>

static std::unique_ptr< Identity > gko::batch::matrix::Identity< ValueType >::create	(	std::shared_ptr< const Executor >	exec,
		const batch_dim< 2 > &	size = `batch_dim< 2 >{}`
	)

static

Creates an Identity matrix of the specified size.

Parameters

exec	Executor associated to the matrix
size	size of the batch matrices in a batch_dim object

Returns: A smart pointer to the newly created matrix.

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

ginkgo/core/matrix/batch_identity.hpp

Identity< ValueType > Class Template Reference

Identity< ValueType > Class Template Reference#

Public Types

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ apply() [1/4]

◆ apply() [2/4]

◆ apply() [3/4]

◆ apply() [4/4]

◆ create()

Identity< ValueType > Class Template Reference

Identity&lt; ValueType &gt; Class Template Reference#

Public Types

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ apply() [1/4]

◆ apply() [2/4]

◆ apply() [3/4]

◆ apply() [4/4]

◆ create()

Identity< ValueType > Class Template Reference#