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

| Ginkgo Generated from branch based on main. Ginkgo version 1.11.0 A numerical linear algebra library targeting many-core architectures

Loading...
Searching...
No Matches
gko::matrix::IdentityFactory< ValueType > Class Template Reference
Linear Operators » SpMV employing different Matrix formats | Linear Operators

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

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

Inheritance diagram for gko::matrix::IdentityFactory< ValueType >:
[legend]
Collaboration diagram for gko::matrix::IdentityFactory< ValueType >:
[legend]

## Public Types
using | value_type = ValueType

## Static Public Member Functions
static std::unique_ptr< IdentityFactory > | create (std::shared_ptr< const Executor > exec)
| Creates a new Identity factory.

## Friends
class | EnablePolymorphicObject< IdentityFactory, LinOpFactory >

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

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