1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
|
/*
* Copyright (c) 2023 Arm Limited.
*
* SPDX-License-Identifier: MIT
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to
* deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
* sell copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
#ifndef CKW_SRC_ITENSORARGUMENT_H
#define CKW_SRC_ITENSORARGUMENT_H
#include "ckw/TensorInfo.h"
#include "ckw/types/TensorComponentType.h"
#include "ckw/types/TensorStorageType.h"
#include "src/ITile.h"
#include <string>
#include <vector>
namespace ckw
{
/** Tensor storage variable */
struct TensorStorageVariable
{
std::string val{ "" }; /** Tensor storage as a string */
std::string type{ "" }; /** Tensor storage type as a string */
};
/** Tensor argument base class.
* A tensor is a multidimensional array used to store data. To access an element (or multiple elements) from a tensor,
* the following information are required:
* -# The data memory object. For example, the pointer to the array
* -# The tensor components, such as the size of each tensor dimension, or the number of elements in bytes contained in each dimension (also known as the "stride")
*/
class ITensorArgument
{
public:
virtual ~ITensorArgument() = default;
/** Method to get the name of the tensor argument.
*
* @return the name of the tensor argument
*/
std::string name() const
{
return _basename;
}
/** Method to get the tensor info
*
* @return the @ref TensorInfo
*/
TensorInfo info() const
{
return _info;
}
protected:
TensorInfo _info{}; // Tensor info
std::string _basename{ "" }; // Tensor name
};
/** Tensor component argument base class */
class ITensorComponentArgument
{
public:
virtual ~ITensorComponentArgument() = default;
/** Method to get the tensor component variable as a string
*
* @param[in] x The tensor component to query
*
* @return the tensor component variable as a @ref TileVariable
*/
virtual TileVariable component(TensorComponentType x) = 0;
/** Method to get all tensor components needed to access the data in the tensor
*
* The tensor components returned by this method must be all passed as kernel argument
*
* @return a vector containing all the tensor components as @ref TileVariable objects
*/
virtual std::vector<TileVariable> components() const = 0;
};
/** Tensor storage argument base class */
class ITensorStorageArgument
{
public:
virtual ~ITensorStorageArgument() = default;
/** Method to get the tensor storage as a string
*
* @param[in] x The tensor storage to query
*
* @return the tensor storage as a @ref TensorStorageVariable
*/
virtual TensorStorageVariable storage(TensorStorageType x) = 0;
/** Method to get all tensor storages needed to access the data in the tensor
*
* The tensor storages returned by this method must be all passed as kernel argument
*
* @return a vector containing all the tensor storages as @ref TensorStorageVariable objects
*/
virtual std::vector<TensorStorageVariable> storages() const = 0;
};
} // namespace ckw
#endif // CKW_SRC_ITENSORARGUMENT_H
|
