gko::batch::matrix::Identity< ValueType > Class Template Reference

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

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

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

Collaboration 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< Identity< ValueType > >
using	result_type = Identity< ValueType >
Public Types inherited from gko::ConvertibleTo< Identity< ValueType > >
using	result_type = Identity< ValueType >

Public Member Functions
Identity *	apply (ptr_param< const MultiVector< value_type >> b, ptr_param< MultiVector< value_type >> x)
	Apply the matrix to a multi-vector. More...
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)
	Apply the matrix to a multi-vector with a linear combination of the given input vector. More...
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< Identity< ValueType >, BatchLinOp >
std::unique_ptr< Identity< ValueType > >	create_default (std::shared_ptr< const Executor > exec) const
std::unique_ptr< Identity< ValueType > >	create_default () const
std::unique_ptr< Identity< ValueType > >	clone (std::shared_ptr< const Executor > exec) const
std::unique_ptr< Identity< ValueType > >	clone () const
Identity< ValueType > *	copy_from (const PolymorphicObject *other)
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, Identity< ValueType > > *	copy_from (std::unique_ptr< Derived > &&other)
std::enable_if_t< std::is_base_of< PolymorphicObject, std::decay_t< Derived > >::value, Identity< ValueType > > *	copy_from (const std::unique_ptr< Derived > &other)
Identity< ValueType > *	copy_from (const std::shared_ptr< const PolymorphicObject > &other)
Identity< ValueType > *	move_from (ptr_param< PolymorphicObject > other)
Identity< ValueType > *	clear ()
Public Member Functions inherited from gko::EnablePolymorphicAssignment< Identity< 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< Identity< 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< Identity >	create (std::shared_ptr< const Executor > exec, const batch_dim< 2 > &size=batch_dim< 2 >{})
	Creates an Identity matrix of the specified size. More...

Friends
class	EnablePolymorphicObject< Identity, BatchLinOp >

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