• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2018-2020 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_NEELEMENTWISEUNARYKERNEL_H
25 #define ARM_COMPUTE_NEELEMENTWISEUNARYKERNEL_H
26 
27 #include "arm_compute/core/Types.h"
28 #include "src/core/NEON/INEKernel.h"
29 
30 namespace arm_compute
31 {
32 class ITensor;
33 
34 /** Interface for an element-wise unary operation kernel
35  *
36  * Element-wise operation is computed by:
37  * @f[ output(x) = OP(input(x))@f]
38  *
39  */
40 class NEElementwiseUnaryKernel : public INEKernel
41 {
42 public:
name()43     const char *name() const override
44     {
45         return "NEElementwiseUnaryKernel";
46     }
47     /** Default constructor */
48     NEElementwiseUnaryKernel();
49     /** Prevent instances of this class from being copied (As this class contains pointers) */
50     NEElementwiseUnaryKernel(const NEElementwiseUnaryKernel &) = delete;
51     /** Prevent instances of this class from being copied (As this class contains pointers) */
52     NEElementwiseUnaryKernel &operator=(const NEElementwiseUnaryKernel &) = delete;
53     /** Allow instances of this class to be moved */
54     NEElementwiseUnaryKernel(NEElementwiseUnaryKernel &&) = default;
55     /** Allow instances of this class to be moved */
56     NEElementwiseUnaryKernel &operator=(NEElementwiseUnaryKernel &&) = default;
57     /** Default destructor */
58     ~NEElementwiseUnaryKernel() = default;
59 
60     /** Function to configure the @ref NEElementwiseUnaryKernel
61      *
62      * @param[in]  op     Arithmetic operation to be executed.
63      * @param[in]  input  First tensor input. Data types supported: F16/F32, F16/F32/S32 for NEG/ABS operations.
64      * @param[out] output Output tensor. Data types supported: Same as @p input.
65      */
66     void configure(ElementWiseUnary op, const ITensor *input, ITensor *output);
67 
68     /** Static function to check if given info will lead to a valid configuration of @ref NEElementwiseUnaryKernel
69      *
70      * @param[in] op     Arithmetic operation to be executed.
71      * @param[in] input  First tensor input info. Data types supported: F16/F32, F16/F32/S32 for NEG/ABS operations.
72      * @param[in] output Output tensor info. Data types supported: Same as @p input.
73      *
74      * @return a Status
75      */
76     static Status validate(ElementWiseUnary op, const ITensorInfo *input, const ITensorInfo *output);
77 
78     // Inherited methods overridden:
79     void run(const Window &window, const ThreadInfo &info) override;
80 
81 private:
82     /** Common signature for all the specialised arithmetic functions
83      *
84      * @param[in] window Region on which to execute the kernel.
85      */
86     using ElementwiseUnaryPtr = void (NEElementwiseUnaryKernel::*)(const Window &window);
87 
88     /** Template function to run elementwise unary operation
89      *
90      * @tparam ScalarType Scalar datatype
91      *
92      * @param[in] window Region on which to execute the kernel. (Must be a valid region of the window returned by window()).
93      */
94     template <typename ScalarType>
95     void elementwise_op(const Window &window);
96 
97     ElementwiseUnaryPtr _func;
98     const ITensor      *_input;
99     ITensor            *_output;
100     ElementWiseUnary    _op;
101 };
102 } // namespace arm_compute
103 #endif /* ARM_COMPUTE_NEELEMENTWISEUNARYKERNEL_H */
104