gko::matrix::IdentityFactory< ValueType > Class Template Reference

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

Inheritance diagram for gko::matrix::IdentityFactory< ValueType >:

Public Types
using	value_type = ValueType

Static Public Member Functions
static std::unique_ptr< IdentityFactory >	create (std::shared_ptr< const Executor > exec)

Protected Member Functions
std::unique_ptr< LinOp >	generate_impl (std::shared_ptr< const LinOp > base) const override
	IdentityFactory (std::shared_ptr< const Executor > exec)
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

Friends
class	EnablePolymorphicObject< IdentityFactory, LinOpFactory >

Additional Inherited Members
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)
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::matrix::IdentityFactory< ValueType >

This factory is a utility which can be used to generate Identity operators.

The factory will generate the Identity matrix with the same dimension as the passed in operator. It will throw an exception if the operator is not square.

Template Parameters

ValueType

precision of matrix elements

Member Function Documentation

create()

template<typename ValueType = default_precision>

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

inlinestatic

Creates a new Identity factory.

Parameters

exec	the executor where the Identity operator will be stored

Returns

a unique pointer to the newly created factory

---

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

• ginkgo/core/matrix/identity.hpp