Compute Library
 22.11
CLActivationLayer.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-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_CLACTIVATIONLAYER_H
25 #define ARM_COMPUTE_CLACTIVATIONLAYER_H
26 
28 
29 #include "arm_compute/core/Types.h"
31 
32 namespace arm_compute
33 {
34 class CLCompileContext;
35 class ICLTensor;
36 class ITensorInfo;
37 
38 /** Basic function to run @ref opencl::kernels::ClActivationKernel
39  *
40  * @note The function simulates an activation layer with the specified activation function.
41  */
43 {
44 public:
45  /** Constructor
46  *
47  * @param[in] ctx Runtime context to be used by the function
48  */
49  CLActivationLayer(CLRuntimeContext *ctx = nullptr);
50  /** Destructor */
52  /** Prevent instances of this class from being copied (As this class contains pointers) */
53  CLActivationLayer(const CLActivationLayer &) = delete;
54  /** Default move constructor */
56  /** Prevent instances of this class from being copied (As this class contains pointers) */
58  /** Default move assignment operator */
60  /** Set the input and output tensor.
61  *
62  * Valid data layouts:
63  * - All
64  *
65  * Valid data type configurations:
66  * |src |dst |
67  * |:--------------|:--------------|
68  * |QASYMM8 |QASYMM8 |
69  * |QASYMM8_SIGNED |QASYMM8_SIGNED |
70  * |QSYMM16 |QSYMM16 |
71  * |F16 |F16 |
72  * |F32 |F32 |
73  *
74  *
75  * @note If the output tensor is a nullptr or is equal to the input, the activation function will be performed in-place
76  *
77  * @param[in, out] input Source tensor. In case of @p output tensor = nullptr, this tensor will store the result
78  * of the activation function. Data types supported: QASYMM8/QASYMM8_SIGNED/QSYMM16/F16/F32.
79  * @param[out] output Destination tensor. Data type supported: same as @p input
80  * @param[in] act_info Activation layer parameters.
81  */
82  void configure(ICLTensor *input, ICLTensor *output, ActivationLayerInfo act_info);
83  /** Set the input and output tensor.
84  *
85  * @note If the output tensor is a nullptr or is equal to the input, the activation function will be performed in-place
86  *
87  * @param[in] compile_context The compile context to be used.
88  * @param[in, out] input Source tensor. In case of @p output tensor = nullptr, this tensor will store the result
89  * of the activation function. Data types supported: QASYMM8/QASYMM8_SIGNED/QSYMM16/F16/F32.
90  * @param[out] output Destination tensor. Data type supported: same as @p input
91  * @param[in] act_info Activation layer parameters.
92  */
93  void configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output, ActivationLayerInfo act_info);
94  /** Static function to check if given info will lead to a valid configuration of @ref CLActivationLayer
95  *
96  * @param[in] input Source tensor info. In case of @p output tensor info = nullptr, this tensor will store the result
97  * of the activation function. Data types supported: QASYMM8/QASYMM8_SIGNED/QSYMM16/F16/F32.
98  * @param[in] output Destination tensor info. Data type supported: same as @p input
99  * @param[in] act_info Activation layer information.
100  *
101  * @return a status
102  */
103  static Status validate(const ITensorInfo *input, const ITensorInfo *output, const ActivationLayerInfo &act_info);
104 
105  // Inherited methods overridden:
106  void run() override;
107 
108 private:
109  struct Impl;
110  std::unique_ptr<Impl> _impl;
111 };
112 } // namespace arm_compute
113 #endif /* ARM_COMPUTE_CLACTIVATIONLAYER_H */
static Status validate(const ITensorInfo *input, const ITensorInfo *output, const ActivationLayerInfo &act_info)
Static function to check if given info will lead to a valid configuration of CLActivationLayer.
Base class for all functions.
Definition: IFunction.h:30
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
void run() override
Run the kernels contained in the function.
Basic function to run opencl::kernels::ClActivationKernel.
Status class.
Definition: Error.h:52
Activation Layer Information class.
Definition: Types.h:1639
Copyright (c) 2017-2022 Arm Limited.
CLActivationLayer(CLRuntimeContext *ctx=nullptr)
Constructor.
CLActivationLayer & operator=(const CLActivationLayer &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
CLCompileContext class.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
void configure(ICLTensor *input, ICLTensor *output, ActivationLayerInfo act_info)
Set the input and output tensor.