• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2019-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_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 
36 namespace experimental
37 {
38 /** Basic function to run @ref CLArithmeticOperationKernel for PRELU
39  *
40  * @note The function implements an activation layer with the PRELU activation function.
41  */
42 class CLPReluLayer : public ICLOperator
43 {
44 public:
45     /** Default Constructor */
46     CLPReluLayer();
47     /** Set the input and output tensor.
48      *
49      * @note If the output tensor is a nullptr or is equal to the input, the activation function will be performed in-place
50      *
51      * @param[in]  compile_context The compile context to be used.
52      * @param[in]  input           Source tensor. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
53      * @param[in]  alpha           PRelu layer parameters. Data types supported: same of @p input.
54      * @param[out] output          Destination tensor. Data type supported: same as @p input
55      */
56     void configure(const CLCompileContext &compile_context, ITensorInfo *input, ITensorInfo *alpha, ITensorInfo *output);
57     /** Static function to check if given info will lead to a valid configuration of @ref CLPReluLayer
58      *
59      * @param[in] input  Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
60      * @param[in] alpha  PRelu layer parameters. Data types supported: same of @p input.
61      * @param[in] output Destination tensor info. Data type supported: same as @p input
62      *
63      * @return a status
64      */
65     static Status validate(const ITensorInfo *input, const ITensorInfo *alpha, const ITensorInfo *output);
66 
67     // Inherited methods overridden:
68     void run(ITensorPack &tensors) override;
69 };
70 } // namespace experimental
71 
72 /** Basic function to run @ref CLArithmeticOperationKernel for PRELU
73  *
74  * @note The function implements an activation layer with the PRELU activation function.
75  */
76 class CLPReluLayer : public IFunction
77 {
78 public:
79     /** Default Constructor */
80     CLPReluLayer();
81     /** Default Destructor */
82     ~CLPReluLayer();
83     /** Prevent instances of this class from being copied (As this class contains pointers) */
84     CLPReluLayer(const CLPReluLayer &) = delete;
85     /** Default move constructor */
86     CLPReluLayer(CLPReluLayer &&);
87     /** Prevent instances of this class from being copied (As this class contains pointers) */
88     CLPReluLayer &operator=(const CLPReluLayer &) = delete;
89     /** Default move assignment operator */
90     CLPReluLayer &operator=(CLPReluLayer &&);
91     /** Set the input and output tensor.
92      *
93      * @note If the output tensor is a nullptr or is equal to the input, the activation function will be performed in-place
94      *
95      * @param[in]  input  Source tensor. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
96      * @param[in]  alpha  PRelu layer parameters. Data types supported: same of @p input.
97      * @param[out] output Destination tensor. Data type supported: same as @p input
98      */
99     void configure(ICLTensor *input, ICLTensor *alpha, ICLTensor *output);
100     /** Set the input and output tensor.
101      *
102      * @note If the output tensor is a nullptr or is equal to the input, the activation function will be performed in-place
103      *
104      * @param[in]  compile_context The compile context to be used.
105      * @param[in]  input           Source tensor. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
106      * @param[in]  alpha           PRelu layer parameters. Data types supported: same of @p input.
107      * @param[out] output          Destination tensor. Data type supported: same as @p input
108      */
109     void configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *alpha, ICLTensor *output);
110     /** Static function to check if given info will lead to a valid configuration of @ref CLPReluLayer
111      *
112      * @param[in] input  Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
113      * @param[in] alpha  PRelu layer parameters. Data types supported: same of @p input.
114      * @param[in] output Destination tensor info. Data type supported: same as @p input
115      *
116      * @return a status
117      */
118     static Status validate(const ITensorInfo *input, const ITensorInfo *alpha, const ITensorInfo *output);
119 
120     // Inherited methods overridden:
121     void run() override;
122 
123 private:
124     struct Impl;
125     std::unique_ptr<Impl> _impl;
126 };
127 } // namespace arm_compute
128 #endif /* ARM_COMPUTE_CLPRELULAYER_H */
129