Compute Library
 21.02
NEPReluLayer.h
Go to the documentation of this file.
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"
30 
31 namespace arm_compute
32 {
33 class ITensor;
34 class ITensorInfo;
35 
36 namespace experimental
37 {
38 /** Basic function to run @ref cpu::kernels::CpuArithmeticKernel for PRELU
39  *
40  * @note The function implements an activation layer with the PRELU activation function.
41  */
42 class NEPRelu : public INEOperator
43 {
44 public:
45  /** Set the input and output tensor.
46  *
47  * @param[in] input Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
48  * @param[in] alpha Source alpha tensor info. Data types supported: same of @p input.
49  * @param[out] output Destination tensor info. Data type supported: same as @p input
50  */
51  void configure(const ITensorInfo *input, const ITensorInfo *alpha, ITensorInfo *output);
52  /** Static function to check if given info will lead to a valid configuration of @ref cpu::kernels::CpuComparisonKernel
53  *
54  * @param[in] input Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
55  * @param[in] alpha Source alpha tensor info. Data types supported: same of @p input.
56  * @param[in] output Destination tensor info. Data type supported: same as @p input
57  *
58  * @return a status
59  */
60  static Status validate(const ITensorInfo *input, const ITensorInfo *alpha, const ITensorInfo *output);
61 };
62 } // namespace experimental
63 
64 /** Basic function to run @ref cpu::kernels::CpuArithmeticKernel for PRELU
65  *
66  * @note The function implements an activation layer with the PRELU activation function.
67  */
68 class NEPReluLayer : public IFunction
69 {
70 public:
71  /** Default Constructor */
72  NEPReluLayer();
73  /** Default Destructor */
74  ~NEPReluLayer();
75  /** Prevent instances of this class from being copied (As this class contains pointers) */
76  NEPReluLayer(const NEPReluLayer &) = delete;
77  /** Default move constructor */
79  /** Prevent instances of this class from being copied (As this class contains pointers) */
80  NEPReluLayer &operator=(const NEPReluLayer &) = delete;
81  /** Default move assignment operator */
83  /** Set the input and output tensor.
84  *
85  * @param[in] input Source tensor. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
86  * @param[in] alpha Source alpha tensor. Data types supported: same of @p input.
87  * @param[out] output Destination tensor. Data type supported: same as @p input
88  */
89  void configure(const ITensor *input, const ITensor *alpha, ITensor *output);
90  /** Static function to check if given info will lead to a valid configuration of @ref NEPReluLayer
91  *
92  * @param[in] input Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32.
93  * @param[in] alpha Source alpha tensor info. Data types supported: same of @p input.
94  * @param[in] output Destination tensor info. Data type supported: same as @p input
95  *
96  * @return a status
97  */
98  static Status validate(const ITensorInfo *input, const ITensorInfo *alpha, const ITensorInfo *output);
99 
100  // Inherited methods overridden:
101  void run() override;
102 
103 private:
104  struct Impl;
105  std::unique_ptr<Impl> _impl;
106 };
107 } // namespace arm_compute
108 #endif /* ARM_COMPUTE_NEPRELULAYER_H */
Base class for all functions.
Definition: IFunction.h:30
Basic interface for functions which have a single async Neon kernel.
Definition: INEOperator.h:41
void configure(const ITensorInfo *input, const ITensorInfo *alpha, ITensorInfo *output)
Set the input and output tensor.
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Interface for Neon tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2021 Arm Limited.
void run(ITensorPack &tensors) override
Run the kernels contained in the function.
Definition: INEOperator.cpp:40
INEOperator & operator=(const INEOperator &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
Basic function to run cpu::kernels::CpuArithmeticKernel for PRELU.
Definition: NEPReluLayer.h:42
Basic function to run cpu::kernels::CpuArithmeticKernel for PRELU.
Definition: NEPReluLayer.h:68
static Status validate(const ITensorInfo *input, const ITensorInfo *alpha, const ITensorInfo *output)
Static function to check if given info will lead to a valid configuration of cpu::kernels::CpuCompari...