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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
/*
* 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_PROTOTYPE_INCLUDE_CKW_TENSORTILESAMPLER_H
#define CKW_PROTOTYPE_INCLUDE_CKW_TENSORTILESAMPLER_H
#include "ckw/types/TensorSamplerTypes.h"
#include <functional>
namespace ckw
{
class TileOperand;
/** Tensor sampler
*
* It contains information about how the result tile should be stored to tensor memory.
* It can also be used to dictate how the subsequent operators fetch the input tensor.
*/
class TensorTileSampler
{
public:
/** Initialize a new instance of @ref TensorSampler class. */
TensorTileSampler();
/** Initialize a new instance of @ref TensorSampler class.
*
* @param[in] x The coordinate in the x dimension.
* @param[in] y The coordinate in the y dimension.
* @param[in] z The coordinate in the z dimension.
* @param[in] b The coordinate in the batch dimension.
* @param[in] format The tensor data format.
* @param[in] address_mode_x The address mode of the x dimension.
* @param[in] address_mode_y The address mode of the y dimension.
* @param[in] address_mode_z The address mode of the z dimension.
*/
TensorTileSampler(TileOperand &x,
TileOperand &y,
TileOperand &z,
TileOperand &b,
TensorSamplerFormat format,
TensorSamplerAddressModeX address_mode_x,
TensorSamplerAddressModeY address_mode_y,
TensorSamplerAddressModeZ address_mode_z);
/** Initialize a new instance of @ref TensorSampler class.
*
* @param[in] x The coordinate in the x dimension.
* @param[in] y The coordinate in the y dimension.
* @param[in] z The coordinate in the z dimension.
* @param[in] b The coordinate in the batch dimension.
* @param[in] height The height of the tile.
* @param[in] width The width of the tile.
* @param[in] format The tensor data format.
* @param[in] address_mode_x The address mode of the x dimension.
* @param[in] address_mode_y The address mode of the y dimension.
* @param[in] address_mode_z The address mode of the z dimension.
*/
TensorTileSampler(TileOperand &x,
TileOperand &y,
TileOperand &z,
TileOperand &b,
int32_t height,
int32_t width,
TensorSamplerFormat format,
TensorSamplerAddressModeX address_mode_x,
TensorSamplerAddressModeY address_mode_y,
TensorSamplerAddressModeZ address_mode_z);
/** Get the coordinate in the x dimension. */
const TileOperand &x() const;
/** Set the coordinate in the x dimension. */
TensorTileSampler &x(TileOperand &x);
/** Get the coordinate in the y dimension. */
const TileOperand &y() const;
/** Set the coordinate in the y dimension. */
TensorTileSampler &y(TileOperand &y);
/** Get the coordinate in the z dimension. */
const TileOperand &z() const;
/** Set the coordinate in the z dimension. */
TensorTileSampler &z(TileOperand &z);
/** Get the coordinate in the batch dimension. */
const TileOperand &b() const;
/** Set the coordinate in the batch dimension. */
TensorTileSampler &b(TileOperand &b);
/** Get the width of the tile. */
int32_t width() const;
/** Set the width of the tile. */
TensorTileSampler &width(int32_t width);
/** Get the height of the tile. */
int32_t height() const;
/** Set the height of the tile. */
TensorTileSampler &height(int32_t height);
/** Get the format of the tensor. */
TensorSamplerFormat format() const;
/** Set the format of the tensor. */
TensorTileSampler &format(TensorSamplerFormat format);
/** Get the address mode of the x dimension. */
TensorSamplerAddressModeX address_mode_x() const;
/** Set the address mode of the x-dimension. */
TensorTileSampler &address_mode_x(TensorSamplerAddressModeX address_mode_x);
/** Get the address mode of the y dimension. */
TensorSamplerAddressModeY address_mode_y() const;
/** Set the address mode of the y dimension. */
TensorTileSampler &address_mode_y(TensorSamplerAddressModeY address_mode_y);
/** Get the address mode of the z dimension. */
TensorSamplerAddressModeZ address_mode_z() const;
/** Set the address mode of the z dimension. */
TensorTileSampler &address_mode_z(TensorSamplerAddressModeZ address_mode_z);
private:
TileOperand *_x{nullptr};
TileOperand *_y{nullptr};
TileOperand *_z{nullptr};
TileOperand *_b{nullptr};
int32_t _height{0};
int32_t _width{0};
TensorSamplerFormat _format{TensorSamplerFormat::Unknown};
TensorSamplerAddressModeX _address_mode_x{TensorSamplerAddressModeX::Unknown};
TensorSamplerAddressModeY _address_mode_y{TensorSamplerAddressModeY::Unknown};
TensorSamplerAddressModeZ _address_mode_z{TensorSamplerAddressModeZ::Unknown};
};
} // namespace ckw
#endif // CKW_PROTOTYPE_INCLUDE_CKW_TENSORTILESAMPLER_H
|
