xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/runtime/NEON/functions/NEElementwiseUnaryLayer.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2018-2021 Arm Limited.
3  *
4  * SPDX-License-Identifier: MIT
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to
8  * deal in the Software without restriction, including without limitation the
9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10  * sell copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 #ifndef ARM_COMPUTE_NEELEMENTWISEUNARYLAYER_H
25 #define ARM_COMPUTE_NEELEMENTWISEUNARYLAYER_H
26 
27 #include "arm_compute/core/Error.h"
28 #include "arm_compute/core/Types.h"
29 #include "arm_compute/runtime/IFunction.h"
30 
31 #include <memory>
32 
33 namespace arm_compute
34 {
35 class ITensor;
36 class ITensorInfo;
37 /** Basic function to perform unary elementwise operations */
38 template <ElementWiseUnary op>
39 class NEElementwiseUnaryLayer : public IFunction
40 {
41 public:
42     /** Default Constructor */
43     NEElementwiseUnaryLayer();
44     /** Default Destructor */
45     ~NEElementwiseUnaryLayer();
46     /** Prevent instances of this class from being copied (As this class contains pointers) */
47     NEElementwiseUnaryLayer(const NEElementwiseUnaryLayer &) = delete;
48     /** Default move constructor */
49     NEElementwiseUnaryLayer(NEElementwiseUnaryLayer &&);
50     /** Prevent instances of this class from being copied (As this class contains pointers) */
51     NEElementwiseUnaryLayer &operator=(const NEElementwiseUnaryLayer &) = delete;
52     /** Default move assignment operator */
53     NEElementwiseUnaryLayer &operator=(NEElementwiseUnaryLayer &&);
54 
55     /** Initialize the function
56      *
57      * Valid data layouts:
58      * - All
59      *
60      * Valid data type configurations:
61      * |src            |dst            |
62      * |:--------------|:--------------|
63      * |F16            |F16            |
64      * |F32            |F32            |
65      * |S32            |S32            |
66      *
67      * @param[in]  input  Input tensor. Data types supported: F16/F32, F16/F32/S32 for NEG/ABS operations.
68      * @param[out] output Output tensor. Data types supported: Same as @p input.
69      */
70     void configure(const ITensor *input, ITensor *output);
71     /** Static function to check if given info will lead to a valid configuration
72      *
73      * @param[in] input  Input tensor info. Data types supported: F16/F32, F16/F32/S32 for NEG/ABS operations.
74      * @param[in] output Output tensor info. Data types supported: Same as @p input.
75      *
76      * @return a status
77      */
78     static Status validate(const ITensorInfo *input, const ITensorInfo *output);
79     // Inherited methods overridden:
80     void run() override;
81 
82 private:
83     struct Impl;
84     std::unique_ptr<Impl> _impl;
85 };
86 
87 using NERsqrtLayer = NEElementwiseUnaryLayer<ElementWiseUnary::RSQRT>;
88 using NEExpLayer   = NEElementwiseUnaryLayer<ElementWiseUnary::EXP>;
89 using NENegLayer   = NEElementwiseUnaryLayer<ElementWiseUnary::NEG>;
90 using NELogLayer   = NEElementwiseUnaryLayer<ElementWiseUnary::LOG>;
91 using NEAbsLayer   = NEElementwiseUnaryLayer<ElementWiseUnary::ABS>;
92 using NERoundLayer = NEElementwiseUnaryLayer<ElementWiseUnary::ROUND>;
93 using NESinLayer   = NEElementwiseUnaryLayer<ElementWiseUnary::SIN>;
94 
95 } // namespace arm_compute
96 #endif /* ARM_COMPUTE_NEELEMENTWISEUNARYLAYER_H */
97