xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/runtime/NEON/functions/NEActivationLayer.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2017-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_NEACTIVATIONLAYER_H
25 #define ARM_COMPUTE_NEACTIVATIONLAYER_H
26 
27 #include "arm_compute/runtime/IFunction.h"
28 
29 #include "arm_compute/core/Types.h"
30 #include "arm_compute/runtime/IRuntimeContext.h"
31 
32 #include <memory>
33 
34 namespace arm_compute
35 {
36 // Forward declarations
37 class ITensor;
38 class ITensorInfo;
39 
40 /** Basic function to run @ref cpu::kernels::CpuActivationKernel
41  *
42  * @note The function simulates an activation layer with the specified activation function.
43  */
44 class NEActivationLayer : public IFunction
45 {
46 public:
47     /** Constructor
48      *
49      * @param[in] ctx Runtime context to be used by the function
50      */
51     NEActivationLayer(IRuntimeContext *ctx = nullptr);
52     /** Prevent instances of this class from being copied (As this class contains pointers) */
53     NEActivationLayer(const NEActivationLayer &) = delete;
54     /** Default move constructor */
55     NEActivationLayer(NEActivationLayer &&);
56     /** Prevent instances of this class from being copied (As this class contains pointers) */
57     NEActivationLayer &operator=(const NEActivationLayer &) = delete;
58     /** Default move assignment operator */
59     NEActivationLayer &operator=(NEActivationLayer &&);
60     /** Destructor */
61     ~NEActivationLayer();
62     /** [NEActivationLayer snippet] **/
63     /** Set the input and output tensor.
64      *
65      * Valid data layouts:
66      * - All
67      *
68      * Valid data type configurations:
69      * |src            |dst            |
70      * |:--------------|:--------------|
71      * |QASYMM8        |QASYMM8        |
72      * |QASYMM8_SIGNED |QASYMM8_SIGNED |
73      * |QSYMM16        |QSYMM16        |
74      * |F16            |F16            |
75      * |F32            |F32            |
76      *
77      * @note If the output tensor is a nullptr or is equal to the input, the activation function will be performed in-place
78      *
79      * @param[in, out] input           Source tensor. In case of @p output tensor = nullptr, this tensor will store the result
80      *                                 of the activation function. Data types supported: QASYMM8/QASYMM8_SIGNED/QSYMM16/F16/F32.
81      * @param[out]     output          Destination tensor. Data type supported: same as @p input
82      * @param[in]      activation_info Activation layer parameters.
83      */
84     void configure(ITensor *input, ITensor *output, ActivationLayerInfo activation_info);
85     /** [NEActivationLayer snippet] **/
86     /** Static function to check if given info will lead to a valid configuration of @ref NEActivationLayer
87      *
88      * @param[in] input    Source tensor info. In case of @p output tensor info = nullptr, this tensor will store the result
89      *                     of the activation function. Data types supported: QASYMM8/QASYMM8_SIGNED/QSYMM16/F16/F32.
90      * @param[in] output   Destination tensor info. Data type supported: same as @p input
91      * @param[in] act_info Activation layer information.
92      *
93      * @return a status
94      */
95     static Status validate(const ITensorInfo *input, const ITensorInfo *output, const ActivationLayerInfo &act_info);
96 
97     // Inherited methods overridden
98     void run() override;
99 
100 private:
101     struct Impl;
102     std::unique_ptr<Impl> _impl;
103 };
104 } // namespace arm_computes
105 #endif /* ARM_COMPUTE_NEACTIVATIONLAYER_H */
106