• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2017-2022 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"
28 #include "src/cpu/ICpuKernel.h"
29 
30 namespace arm_compute
31 {
32 namespace cpu
33 {
34 namespace kernels
35 {
36 /** Interface for the activation kernel */
37 class CpuActivationKernel : public ICpuKernel<CpuActivationKernel>
38 {
39 private:
40     using ActivationKernelPtr = std::add_pointer<void(const ITensor *, ITensor *, const ActivationLayerInfo &, const Window &)>::type;
41 
42 public:
43     CpuActivationKernel() = default;
44     ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE(CpuActivationKernel);
45     /** Configure kernel for a given list of arguments
46      *
47      * @note If the output tensor is a nullptr, the activation function will be performed in-place
48      *
49      * @param[in, out] src             Source tensor info. In case of @p dst tensor = nullptr, this tensor will store the result
50      *                                 of the activation function. Data types supported: QASYMM8/QASYMM8_SIGNED/QSYMM16/F16/F32.
51      * @param[out]     dst             Destination tensor info. Data type supported: same as @p src
52      * @param[in]      activation_info Activation layer information.
53      */
54     void configure(const ITensorInfo *src, ITensorInfo *dst, ActivationLayerInfo activation_info);
55     /** Static function to check if given info will lead to a valid configuration
56      *
57      * Similar to CpuActivationKernel::configure()
58      *
59      * @return a status
60      */
61     static Status validate(const ITensorInfo *src, const ITensorInfo *dst, const ActivationLayerInfo &act_info);
62 
63     /** Return minimum workload size of the relevant kernel
64      *
65      * @param[in] platform     The CPU platform used to create the context.
66      * @param[in] thread_count Number of threads in the execution.
67      *
68      * @return[out] small_network_mws          Minimum workload size for requsted configuration.
69      */
70     size_t get_mws(const CPUInfo &platform, size_t thread_count) const override;
71 
72     // Inherited methods overridden:
73     void run_op(ITensorPack &tensors, const Window &window, const ThreadInfo &info) override;
74     const char *name() const override;
75 
76     /** Get the preferred dimension in which the scheduler splits the work into multiple jobs.
77      *
78      * @return The split dimension hint.
79      */
get_split_dimension_hint()80     size_t get_split_dimension_hint() const
81     {
82         return _split_dimension;
83     }
84 
85     struct ActivationKernel
86     {
87         const char                                *name;
88         const ActivationDataTypeISASelectorDataPtr is_selected;
89         ActivationKernelPtr                        ukernel;
90     };
91 
92     static const std::vector<ActivationKernel> &get_available_kernels();
93 
94 private:
95     ActivationLayerInfo _act_info{};
96     ActivationKernelPtr _run_method{ nullptr };
97     size_t              _split_dimension{ Window::DimY };
98     std::string         _name{};
99 };
100 } // namespace kernels
101 } // namespace cpu
102 } // namespace arm_compute
103 #endif /* ARM_COMPUTE_CPU_ACTIVATION_KERNEL_H */
104