xref: /aosp_15_r20/external/ComputeLibrary/src/cpu/kernels/CpuElementwiseUnaryKernel.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2018-2022 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_CPU_ELEMENTWISE_UNARY_KERNEL_H
25 #define ARM_COMPUTE_CPU_ELEMENTWISE_UNARY_KERNEL_H
26 
27 #include "arm_compute/core/Types.h"
28 #include "src/core/common/Macros.h"
29 #include "src/cpu/ICpuKernel.h"
30 
31 namespace arm_compute
32 {
33 namespace cpu
34 {
35 namespace kernels
36 {
37 /** Interface for an element-wise unary operation kernel
38  *
39  * Element-wise operation is computed by:
40  * @f[ dst(x) = OP(src(x))@f]
41  */
42 class CpuElementwiseUnaryKernel : public ICpuKernel<CpuElementwiseUnaryKernel>
43 {
44 private:
45     using ElementwiseUnaryUkernelPtr = std::add_pointer<void(const ITensor *, ITensor *, const Window &, ElementWiseUnary)>::type;
46 
47 public:
48     CpuElementwiseUnaryKernel() = default;
49     ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE(CpuElementwiseUnaryKernel);
50 
51     /** Function to configure the @ref CpuElementwiseUnaryKernel
52      *
53      * @param[in]  op  Arithmetic operation to be executed.
54      * @param[in]  src First tensor input. Data types supported: F16/F32, F16/F32/S32 for NEG/ABS operations.
55      * @param[out] dst Output tensor. Data types supported: Same as @p src.
56      */
57     void configure(ElementWiseUnary op, const ITensorInfo &src, ITensorInfo &dst);
58     /** Static function to check if given info will lead to a valid configuration
59      *
60      * Similar to CpuElementwiseUnaryKernel::configure()
61      *
62      * @return a status
63      */
64     static Status validate(ElementWiseUnary op, const ITensorInfo &src, const ITensorInfo &dst);
65 
66     // Inherited methods overridden:
67     void run_op(ITensorPack &tensors, const Window &window, const ThreadInfo &info) override;
68     const char *name() const override;
69 
70     struct ElementwiseUnaryKernel
71     {
72         const char                  *name;
73         const DataTypeISASelectorPtr is_selected;
74         ElementwiseUnaryUkernelPtr   ukernel;
75     };
76 
77     static const std::vector<ElementwiseUnaryKernel> &get_available_kernels();
78 
79 private:
80     ElementWiseUnary           _op{};
81     ElementwiseUnaryUkernelPtr _run_method{ nullptr };
82     std::string                _name{};
83 };
84 } // namespace kernels
85 } // namespace cpu
86 } // namespace arm_compute
87 #endif /* ARM_COMPUTE_CPU_ELEMENTWISE_UNARY_KERNEL_H */
88