Compute Library
 21.05
CpuActivationKernel.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-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_CPU_ACTIVATION_KERNEL_H
25 #define ARM_COMPUTE_CPU_ACTIVATION_KERNEL_H
26 
27 #include "src/core/common/Macros.h"
29 
30 namespace arm_compute
31 {
32 namespace cpu
33 {
34 namespace kernels
35 {
36 /** Interface for the activation kernel */
38 {
39 public:
40  CpuActivationKernel() = default;
42  /** Configure kernel for a given list of arguments
43  *
44  * @note If the output tensor is a nullptr, the activation function will be performed in-place
45  *
46  * @param[in, out] src Source tensor info. In case of @p dst tensor = nullptr, this tensor will store the result
47  * of the activation function. Data types supported: QASYMM8/QASYMM8_SIGNED/QSYMM16/F16/F32.
48  * @param[out] dst Destination tensor info. Data type supported: same as @p src
49  * @param[in] activation_info Activation layer information.
50  */
51  void configure(const ITensorInfo *src, ITensorInfo *dst, ActivationLayerInfo activation_info);
52  /** Static function to check if given info will lead to a valid configuration of @ref CpuActivationKernel
53  *
54  * @param[in] src Source tensor info. In case of @p dst tensor info = nullptr, this tensor will store the result
55  * of the activation function. Data types supported: QASYMM8/QASYMM8_SIGNED/QSYMM16/F16/F32.
56  * @param[in] dst Destination tensor info. Data type supported: same as @p src
57  * @param[in] act_info Activation layer information.
58  *
59  * @return a status
60  */
61  static Status validate(const ITensorInfo *src, const ITensorInfo *dst, const ActivationLayerInfo &act_info);
62 
63  // Inherited methods overridden:
64  void run_op(ITensorPack &tensors, const Window &window, const ThreadInfo &info) override;
65  const char *name() const override;
66 
67 private:
68  ActivationLayerInfo _act_info{};
69 };
70 } // namespace kernels
71 } // namespace cpu
72 } // namespace arm_compute
73 #endif /* ARM_COMPUTE_CPU_ACTIVATION_KERNEL_H */
ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE(CpuActivationKernel)
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
void run_op(ITensorPack &tensors, const Window &window, const ThreadInfo &info) override
Execute the kernel on the passed window.
void configure(const ITensorInfo *src, ITensorInfo *dst, ActivationLayerInfo activation_info)
Configure kernel for a given list of arguments.
Common interface for all kernels implemented in C++.
Definition: ICPPKernel.h:38
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Activation Layer Information class.
Definition: Types.h:1478
SimpleTensor< float > src
Definition: DFT.cpp:155
const char * name() const override
Name of the kernel.
Copyright (c) 2017-2021 Arm Limited.
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
Information about executing thread and CPU.
Definition: CPPTypes.h:252
Tensor packing service.
Definition: ITensorPack.h:37
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 CpuActivationKernel.
Interface for the activation kernel.
Describe a multidimensional execution window.
Definition: Window.h:39