xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/runtime/NEON/functions/NEPReluLayer.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2019-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_NEPRELULAYER_H
25 #define ARM_COMPUTE_NEPRELULAYER_H
26 
27 #include "arm_compute/core/Types.h"
28 #include "arm_compute/runtime/IFunction.h"
29 
30 #include <memory>
31 
32 namespace arm_compute
33 {
34 class ITensor;
35 class ITensorInfo;
36 
37 /** Basic function to run @ref cpu::kernels::CpuArithmeticKernel for PRELU
38  *
39  * @note The function implements an activation layer with the PRELU activation function.
40  */
41 class NEPReluLayer : public IFunction
42 {
43 public:
44     /** Default Constructor */
45     NEPReluLayer();
46     /** Default Destructor */
47     ~NEPReluLayer();
48     /** Prevent instances of this class from being copied (As this class contains pointers) */
49     NEPReluLayer(const NEPReluLayer &) = delete;
50     /** Default move constructor */
51     NEPReluLayer(NEPReluLayer &&);
52     /** Prevent instances of this class from being copied (As this class contains pointers) */
53     NEPReluLayer &operator=(const NEPReluLayer &) = delete;
54     /** Default move assignment operator */
55     NEPReluLayer &operator=(NEPReluLayer &&);
56     /** Set the input and output tensor.
57      *
58      * Valid data layouts:
59      * - All
60      *
61      * Valid data type configurations:
62      * |src            |dst            |
63      * |:--------------|:--------------|
64      * |QASYMM8        |QASYMM8        |
65      * |QASYMM8_SIGNED |QASYMM8_SIGNED |
66      * |F16            |F16            |
67      * |F32            |F32            |
68      *
69      * @param[in]  input  Source tensor. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
70      * @param[in]  alpha  Source alpha tensor. Data types supported: same of @p input.
71      * @param[out] output Destination tensor. Data type supported: same as @p input
72      */
73     void configure(const ITensor *input, const ITensor *alpha, ITensor *output);
74     /** Static function to check if given info will lead to a valid configuration of @ref NEPReluLayer
75      *
76      * @param[in] input  Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
77      * @param[in] alpha  Source alpha tensor info. Data types supported: same of @p input.
78      * @param[in] output Destination tensor info. Data type supported: same as @p input
79      *
80      * @return a status
81      */
82     static Status validate(const ITensorInfo *input, const ITensorInfo *alpha, const ITensorInfo *output);
83 
84     // Inherited methods overridden:
85     void run() override;
86 
87 private:
88     struct Impl;
89     std::unique_ptr<Impl> _impl;
90 };
91 } // namespace arm_compute
92 #endif /* ARM_COMPUTE_NEPRELULAYER_H */
93