aboutsummaryrefslogtreecommitdiff
path: root/arm_compute/runtime/CL/functions/CLElementWiseUnaryLayer.h
blob: 5208bfe404002358d5ebe088aa002d4da2324694 (plain)
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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
/*
 * Copyright (c) 2018-2020 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 ARM_COMPUTE_CLELEMENTWISEUNARYLAYER_H
#define ARM_COMPUTE_CLELEMENTWISEUNARYLAYER_H

#include "arm_compute/runtime/CL/ICLOperator.h"
#include "arm_compute/runtime/CL/ICLSimpleFunction.h"

namespace arm_compute
{
class ICLTensor;

/** Basic function to perform inverse square root on an input tensor. */
class CLRsqrtLayer : public IFunction
{
public:
    /** Default Constructor */
    CLRsqrtLayer();
    /** Default Destructor */
    ~CLRsqrtLayer();
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    CLRsqrtLayer(const CLRsqrtLayer &) = delete;
    /** Default move constructor */
    CLRsqrtLayer(CLRsqrtLayer &&);
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    CLRsqrtLayer &operator=(const CLRsqrtLayer &) = delete;
    /** Default move assignment operator */
    CLRsqrtLayer &operator=(CLRsqrtLayer &&);
    /** Initialize the function
     *
     * @param[in]  input  Input tensor. Data types supported: F16/F32.
     * @param[out] output Output tensor. Data types supported: same as @p input.
     */
    void configure(const ICLTensor *input, ICLTensor *output);
    /** Initialize the function
     *
     * @param[in]  compile_context The compile context to be used.
     * @param[in]  input           Input tensor. Data types supported: F16/F32.
     * @param[out] output          Output tensor. Data types supported: same as @p input.
     */
    void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output);
    /** Static function to check if given info will lead to a valid configuration of @ref CLRsqrtLayer
     *
     * @param[in] input  First tensor input info. Data types supported: F16/F32.
     * @param[in] output Output tensor info. Data types supported: Same as @p input.
     *
     * @return a status
     */
    static Status validate(const ITensorInfo *input, const ITensorInfo *output);

    // Inherited methods overridden:
    void run() override;

private:
    struct Impl;
    std::unique_ptr<Impl> _impl;
};

/** Basic function to perform exponential on an input tensor. */
class CLExpLayer : public IFunction
{
public:
    /** Default Constructor */
    CLExpLayer();
    /** Default Destructor */
    ~CLExpLayer();
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    CLExpLayer(const CLExpLayer &) = delete;
    /** Default move constructor */
    CLExpLayer(CLExpLayer &&);
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    CLExpLayer &operator=(const CLExpLayer &) = delete;
    /** Default move assignment operator */
    CLExpLayer &operator=(CLExpLayer &&);
    /** Initialize the function
     *
     * @param[in]  input  Input tensor. Data types supported: F16/F32.
     * @param[out] output Output tensor. Data types supported: same as @p input.
     */
    void configure(const ICLTensor *input, ICLTensor *output);
    /** Initialize the function
     *
     * @param[in]  compile_context The compile context to be used.
     * @param[in]  input           Input tensor. Data types supported: F16/F32.
     * @param[out] output          Output tensor. Data types supported: same as @p input.
     */
    void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output);
    /** Static function to check if given info will lead to a valid configuration of @ref CLExpLayer
     *
     * @param[in] input  First tensor input info. Data types supported: F16/F32.
     * @param[in] output Output tensor info. Data types supported: Same as @p input.
     *
     * @return a status
     */
    static Status validate(const ITensorInfo *input, const ITensorInfo *output);

    // Inherited methods overridden:
    void run() override;

private:
    struct Impl;
    std::unique_ptr<Impl> _impl;
};

/** Basic function to negate an input tensor. */
class CLNegLayer : public IFunction
{
public:
    /** Default Constructor */
    CLNegLayer();
    /** Default Destructor */
    ~CLNegLayer();
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    CLNegLayer(const CLNegLayer &) = delete;
    /** Default move constructor */
    CLNegLayer(CLNegLayer &&);
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    CLNegLayer &operator=(const CLNegLayer &) = delete;
    /** Default move assignment operator */
    CLNegLayer &operator=(CLNegLayer &&);
    /** Initialize the function
     *
     * @param[in]  input  Input tensor. Data types supported: F16/F32.
     * @param[out] output Output tensor. Data types supported: same as @p input.
     */
    void configure(const ICLTensor *input, ICLTensor *output);
    /** Initialize the function
     *
     * @param[in]  compile_context The compile context to be used.
     * @param[in]  input           Input tensor. Data types supported: F16/F32.
     * @param[out] output          Output tensor. Data types supported: same as @p input.
     */
    void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output);
    /** Static function to check if given info will lead to a valid configuration of @ref CLNegLayer
     *
     * @param[in] input  First tensor input info. Data types supported: F16/F32.
     * @param[in] output Output tensor info. Data types supported: Same as @p input.
     *
     * @return a status
     */
    static Status validate(const ITensorInfo *input, const ITensorInfo *output);

    // Inherited methods overridden:
    void run() override;

private:
    struct Impl;
    std::unique_ptr<Impl> _impl;
};

/** Basic function to calculate sine of an input tensor. */
class CLSinLayer : public IFunction
{
public:
    /** Default Constructor */
    CLSinLayer();
    /** Default Destructor */
    ~CLSinLayer();
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    CLSinLayer(const CLSinLayer &) = delete;
    /** Default move constructor */
    CLSinLayer(CLSinLayer &&);
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    CLSinLayer &operator=(const CLSinLayer &) = delete;
    /** Default move assignment operator */
    CLSinLayer &operator=(CLSinLayer &&);
    /** Initialize the function
     *
     * @param[in]  input  Input tensor. Data types supported: F16/F32.
     * @param[out] output Output tensor. Data types supported: same as @p input.
     */
    void configure(const ICLTensor *input, ICLTensor *output);
    /** Initialize the function
     *
     * @param[in]  compile_context The compile context to be used.
     * @param[in]  input           Input tensor. Data types supported: F16/F32.
     * @param[out] output          Output tensor. Data types supported: same as @p input.
     */
    void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output);
    /** Static function to check if given info will lead to a valid configuration of @ref CLSinLayer
     *
     * @param[in] input  First tensor input info. Data types supported: F16/F32.
     * @param[in] output Output tensor info. Data types supported: Same as @p input.
     *
     * @return a status
     */
    static Status validate(const ITensorInfo *input, const ITensorInfo *output);

    // Inherited methods overridden:
    void run() override;

private:
    struct Impl;
    std::unique_ptr<Impl> _impl;
};

/** Basic function to perform elementwise log on an input tensor. */
class CLLogLayer : public IFunction
{
public:
    /** Default Constructor */
    CLLogLayer();
    /** Default Destructor */
    ~CLLogLayer();
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    CLLogLayer(const CLLogLayer &) = delete;
    /** Default move constructor */
    CLLogLayer(CLLogLayer &&);
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    CLLogLayer &operator=(const CLLogLayer &) = delete;
    /** Default move assignment operator */
    CLLogLayer &operator=(CLLogLayer &&);
    /** Initialize the function
     *
     * @param[in]  input  Input tensor. Data types supported: F16/F32.
     * @param[out] output Output tensor. Data types supported: same as @p input.
     */
    void configure(const ICLTensor *input, ICLTensor *output);
    /** Initialize the function
     *
     * @param[in]  compile_context The compile context to be used.
     * @param[in]  input           Input tensor. Data types supported: F16/F32.
     * @param[out] output          Output tensor. Data types supported: same as @p input.
     */
    void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output);
    /** Static function to check if given info will lead to a valid configuration of @ref CLLogLayer
     *
     * @param[in] input  First tensor input info. Data types supported: F16/F32.
     * @param[in] output Output tensor info. Data types supported: Same as @p input.
     *
     * @return a status
     */
    static Status validate(const ITensorInfo *input, const ITensorInfo *output);

    // Inherited methods overridden:
    void run() override;

private:
    struct Impl;
    std::unique_ptr<Impl> _impl;
};

/** Basic function to get the absolute value of an input tensor. */
class CLAbsLayer : public IFunction
{
public:
    /** Default Constructor */
    CLAbsLayer();
    /** Default Destructor */
    ~CLAbsLayer();
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    CLAbsLayer(const CLAbsLayer &) = delete;
    /** Default move constructor */
    CLAbsLayer(CLAbsLayer &&);
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    CLAbsLayer &operator=(const CLAbsLayer &) = delete;
    /** Default move assignment operator */
    CLAbsLayer &operator=(CLAbsLayer &&);
    /** Initialize the function
     *
     * @param[in]  input  Input tensor. Data types supported: F16/F32.
     * @param[out] output Output tensor. Data types supported: same as @p input.
     */
    void configure(const ICLTensor *input, ICLTensor *output);
    /** Initialize the function
     *
     * @param[in]  compile_context The compile context to be used.
     * @param[in]  input           Input tensor. Data types supported: F16/F32.
     * @param[out] output          Output tensor. Data types supported: same as @p input.
     */
    void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output);
    /** Static function to check if given info will lead to a valid configuration of @ref CLAbsLayer
     *
     * @param[in] input  First tensor input info. Data types supported: F16/F32.
     * @param[in] output Output tensor info. Data types supported: Same as @p input.
     *
     * @return a status
     */
    static Status validate(const ITensorInfo *input, const ITensorInfo *output);

    // Inherited methods overridden:
    void run() override;

private:
    struct Impl;
    std::unique_ptr<Impl> _impl;
};

/** Basic function to get the round (to the nearest even) value of an input tensor. */
class CLRoundLayer : public IFunction
{
public:
    /** Default Constructor */
    CLRoundLayer();
    /** Default Destructor */
    ~CLRoundLayer();
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    CLRoundLayer(const CLRoundLayer &) = delete;
    /** Default move constructor */
    CLRoundLayer(CLRoundLayer &&);
    /** Prevent instances of this class from being copied (As this class contains pointers) */
    CLRoundLayer &operator=(const CLRoundLayer &) = delete;
    /** Default move assignment operator */
    CLRoundLayer &operator=(CLRoundLayer &&);
    /** Initialize the function
     *
     * @param[in]  input  Input tensor. Data types supported: F16/F32.
     * @param[out] output Output tensor. Data types supported: same as @p input.
     */
    void configure(const ICLTensor *input, ICLTensor *output);
    /** Initialize the function
     *
     * @param[in]  compile_context The compile context to be used.
     * @param[in]  input           Input tensor. Data types supported: F16/F32.
     * @param[out] output          Output tensor. Data types supported: same as @p input.
     */
    void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output);
    /** Static function to check if given info will lead to a valid configuration of @ref CLRoundLayer
     *
     * @param[in] input  First tensor input info. Data types supported: F16/F32.
     * @param[in] output Output tensor info. Data types supported: Same as @p input.
     *
     * @return a status
     */
    static Status validate(const ITensorInfo *input, const ITensorInfo *output);

    // Inherited methods overridden:
    void run() override;

private:
    struct Impl;
    std::unique_ptr<Impl> _impl;
};

namespace experimental
{
/** Basic function to perform inverse square root on an input tensor. */
class CLRsqrt : public ICLOperator
{
public:
    /** Initialize the function
     *
     * @param[in]  input  Input tensor info. Data types supported: F16/F32.
     * @param[out] output Output tensor info. Data types supported: same as @p input.
     */
    void configure(const ITensorInfo *input, ITensorInfo *output);
    /** Initialize the function
     *
     * @param[in]  compile_context The compile context to be used.
     * @param[in]  input           Input tensor info. Data types supported: F16/F32.
     * @param[out] output          Output tensor info. Data types supported: same as @p input.
     */
    void configure(const CLCompileContext &compile_context, const ITensorInfo *input, ITensorInfo *output);
    /** Static function to check if given info will lead to a valid configuration of @ref CLRsqrtLayer
     *
     * @param[in] input  First tensor input info. Data types supported: F16/F32.
     * @param[in] output Output tensor info. Data types supported: Same as @p input.
     *
     * @return a status
     */
    static Status validate(const ITensorInfo *input, const ITensorInfo *output);
};

/** Basic function to perform exponential on an input tensor. */
class CLExp : public ICLOperator
{
public:
    /** Initialize the function
     *
     * @param[in]  input  Input tensor info. Data types supported: F16/F32.
     * @param[out] output Output tensor info. Data types supported: same as @p input.
     */
    void configure(const ITensorInfo *input, ITensorInfo *output);
    /** Initialize the function
     *
     * @param[in]  compile_context The compile context to be used.
     * @param[in]  input           Input tensor info. Data types supported: F16/F32.
     * @param[out] output          Output tensor info. Data types supported: same as @p input.
     */
    void configure(const CLCompileContext &compile_context, const ITensorInfo *input, ITensorInfo *output);
    /** Static function to check if given info will lead to a valid configuration of @ref CLExpLayer
     *
     * @param[in] input  First tensor input info. Data types supported: F16/F32.
     * @param[in] output Output tensor info. Data types supported: Same as @p input.
     *
     * @return a status
     */
    static Status validate(const ITensorInfo *input, const ITensorInfo *output);
};

/** Basic function to negate an input tensor. */
class CLNeg : public ICLOperator
{
public:
    /** Initialize the function
     *
     * @param[in]  input  Input tensor info. Data types supported: F16/F32.
     * @param[out] output Output tensor info. Data types supported: same as @p input.
     */
    void configure(const ITensorInfo *input, ITensorInfo *output);
    /** Initialize the function
     *
     * @param[in]  compile_context The compile context to be used.
     * @param[in]  input           Input tensor info. Data types supported: F16/F32.
     * @param[out] output          Output tensor info. Data types supported: same as @p input.
     */
    void configure(const CLCompileContext &compile_context, const ITensorInfo *input, ITensorInfo *output);
    /** Static function to check if given info will lead to a valid configuration of @ref CLNegLayer
     *
     * @param[in] input  First tensor input info. Data types supported: F16/F32.
     * @param[in] output Output tensor info. Data types supported: Same as @p input.
     *
     * @return a status
     */
    static Status validate(const ITensorInfo *input, const ITensorInfo *output);
};

/** Basic function to calculate sine of an input tensor. */
class CLSin : public ICLOperator
{
public:
    /** Initialize the function
     *
     * @param[in]  input  Input tensor info. Data types supported: F16/F32.
     * @param[out] output Output tensor info. Data types supported: same as @p input.
     */
    void configure(const ITensorInfo *input, ITensorInfo *output);
    /** Initialize the function
     *
     * @param[in]  compile_context The compile context to be used.
     * @param[in]  input           Input tensor info. Data types supported: F16/F32.
     * @param[out] output          Output tensor info. Data types supported: same as @p input.
     */
    void configure(const CLCompileContext &compile_context, const ITensorInfo *input, ITensorInfo *output);
    /** Static function to check if given info will lead to a valid configuration of @ref CLSinLayer
     *
     * @param[in] input  First tensor input info. Data types supported: F16/F32.
     * @param[in] output Output tensor info. Data types supported: Same as @p input.
     *
     * @return a status
     */
    static Status validate(const ITensorInfo *input, const ITensorInfo *output);
};

/** Basic function to perform elementwise log on an input tensor. */
class CLLog : public ICLOperator
{
public:
    /** Initialize the function
     *
     * @param[in]  input  Input tensor info. Data types supported: F16/F32.
     * @param[out] output Output tensor info. Data types supported: same as @p input.
     */
    void configure(const ITensorInfo *input, ITensorInfo *output);
    /** Initialize the function
     *
     * @param[in]  compile_context The compile context to be used.
     * @param[in]  input           Input tensor info. Data types supported: F16/F32.
     * @param[out] output          Output tensor info. Data types supported: same as @p input.
     */
    void configure(const CLCompileContext &compile_context, const ITensorInfo *input, ITensorInfo *output);
    /** Static function to check if given info will lead to a valid configuration of @ref CLLogLayer
     *
     * @param[in] input  First tensor input info. Data types supported: F16/F32.
     * @param[in] output Output tensor info. Data types supported: Same as @p input.
     *
     * @return a status
     */
    static Status validate(const ITensorInfo *input, const ITensorInfo *output);
};

/** Basic function to get the absolute value of an input tensor. */
class CLAbs : public ICLOperator
{
public:
    /** Initialize the function
     *
     * @param[in]  input  Input tensor info. Data types supported: F16/F32.
     * @param[out] output Output tensor info. Data types supported: same as @p input.
     */
    void configure(const ITensorInfo *input, ITensorInfo *output);
    /** Initialize the function
     *
     * @param[in]  compile_context The compile context to be used.
     * @param[in]  input           Input tensor info. Data types supported: F16/F32.
     * @param[out] output          Output tensor info. Data types supported: same as @p input.
     */
    void configure(const CLCompileContext &compile_context, const ITensorInfo *input, ITensorInfo *output);
    /** Static function to check if given info will lead to a valid configuration of @ref CLAbsLayer
     *
     * @param[in] input  First tensor input info. Data types supported: F16/F32.
     * @param[in] output Output tensor info. Data types supported: Same as @p input.
     *
     * @return a status
     */
    static Status validate(const ITensorInfo *input, const ITensorInfo *output);
};

/** Basic function to get the round (to the nearest even) value of an input tensor. */
class CLRound : public ICLOperator
{
public:
    /** Initialize the function
     *
     * @param[in]  input  Input tensor info. Data types supported: F16/F32.
     * @param[out] output Output tensor info. Data types supported: same as @p input.
     */
    void configure(const ITensorInfo *input, ITensorInfo *output);
    /** Initialize the function
     *
     * @param[in]  compile_context The compile context to be used.
     * @param[in]  input           Input tensor info. Data types supported: F16/F32.
     * @param[out] output          Output tensor info. Data types supported: same as @p input.
     */
    void configure(const CLCompileContext &compile_context, const ITensorInfo *input, ITensorInfo *output);
    /** Static function to check if given info will lead to a valid configuration of @ref CLRoundLayer
     *
     * @param[in] input  First tensor input info. Data types supported: F16/F32.
     * @param[in] output Output tensor info. Data types supported: Same as @p input.
     *
     * @return a status
     */
    static Status validate(const ITensorInfo *input, const ITensorInfo *output);
};
} // namespace experimental
} // namespace arm_compute
#endif /* ARM_COMPUTE_CLELEMENTWISEUNARYLAYER_H */