Compute Library
 21.05
ClActivationKernel.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_CL_ACTIVATION_KERNEL_H
25 #define ARM_COMPUTE_CL_ACTIVATION_KERNEL_H
26 
27 #include "src/core/common/Macros.h"
30 
31 namespace arm_compute
32 {
33 namespace opencl
34 {
35 namespace kernels
36 {
37 /** Interface for the activation kernel. */
39 {
40 public:
43  /** Configure kernel for a given list of arguments
44  *
45  * @note If the output tensor is a nullptr, the activation function will be performed in-place
46  *
47  * @param[in] compile_context The compile context to be used.
48  * @param[in, out] src Source tensor info. In case of @p dst tensor = nullptr, this tensor will store the result
49  * of the activation function. Data types supported: QASYMM8/QASYMM8_SIGNED/QSYMM16/F16/F32.
50  * @param[out] dst Destination tensor info. Data type supported: same as @p src
51  * @param[in] act_info Activation layer information.
52  */
53  void configure(const ClCompileContext &compile_context, ITensorInfo *src, ITensorInfo *dst, ActivationLayerInfo act_info);
54  /** Static function to check if given info will lead to a valid configuration of @ref ClActivationKernel
55  *
56  * @param[in] src Source tensor info. In case of @p dst tensor info = nullptr, this tensor will store the result
57  * of the activation function. Data types supported: QASYMM8/QASYMM8_SIGNED/QSYMM16/F16/F32.
58  * @param[in] dst Destination tensor info. Data type supported: same as @p src
59  * @param[in] act_info Activation layer information.
60  *
61  * @return a status
62  */
63  static Status validate(const ITensorInfo *src, const ITensorInfo *dst, const ActivationLayerInfo &act_info);
64 
65  // Inherited methods overridden:
66  void run_op(ITensorPack &tensors, const Window &window, ::cl::CommandQueue &queue) override;
67 
68 private:
69  bool _run_in_place;
70 };
71 } // namespace kernels
72 } // namespace opencl
73 } // namespace arm_compute
74 #endif /* ARM_COMPUTE_CL_ACTIVATION_KERNEL_H */
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Interface for the activation kernel.
Status class.
Definition: Error.h:52
Common interface for all the OpenCL kernels.
Definition: ICLKernel.h:46
Activation Layer Information class.
Definition: Types.h:1478
SimpleTensor< float > src
Definition: DFT.cpp:155
Copyright (c) 2017-2021 Arm Limited.
void configure(const ClCompileContext &compile_context, ITensorInfo *src, ITensorInfo *dst, ActivationLayerInfo act_info)
Configure kernel for a given list of arguments.
static Status validate(const ITensorInfo *src, const ITensorInfo *dst, const ActivationLayerInfo &act_info)
Static function to check if given info will lead to a valid configuration of ClActivationKernel.
void run_op(ITensorPack &tensors, const Window &window, ::cl::CommandQueue &queue) override
CLCompileContext class.
Tensor packing service.
Definition: ITensorPack.h:37
Describe a multidimensional execution window.
Definition: Window.h:39