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