xref: /aosp_15_r20/external/ComputeLibrary/src/cpu/kernels/CpuSubKernel.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2016-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_SUB_KERNEL_H
25 #define ARM_COMPUTE_CPU_SUB_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 kernel to perform subtraction between two tensors */
37 class CpuSubKernel : public ICpuKernel<CpuSubKernel>
38 {
39 private:
40     using SubKernelPtr                           = std::add_pointer<void(const ITensor *, const ITensor *, ITensor *, const ConvertPolicy &, const Window &)>::type;
41     using CpuSubKernelDataTypeISASelectorDataPtr = CpuAddKernelDataTypeISASelectorDataPtr;
42 
43 public:
44     CpuSubKernel() = default;
45     ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE(CpuSubKernel);
46 
47     /** Initialise the kernel's src and dst.
48      *
49      * Valid configurations (src0,src1) -> dst :
50      *
51      *   - (U8,U8)                          -> U8
52      *   - (QASYMM8, QASYMM8)               -> QASYMM8
53      *   - (QASYMM8_SIGNED, QASYMM8_SIGNED) -> QASYMM8_SIGNED
54      *   - (S16,S16)                        -> S16
55      *   - (S32,S32)                        -> S32
56      *   - (F16,F16)                        -> F16
57      *   - (F32,F32)                        -> F32
58      *
59      * @param[in]  src0   An input tensor. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/QSYMM16/S16/S32/F16/F32
60      * @param[in]  src1   An input tensor. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/QSYMM16/S16/S32/F16/F32
61      * @param[out] dst    The dst tensor. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/QSYMM16/S16/S32/F16/F32.
62      * @param[in]  policy Overflow policy. Convert policy cannot be WRAP if datatype is quantized.
63      */
64     void configure(const ITensorInfo *src0, const ITensorInfo *src1, ITensorInfo *dst, ConvertPolicy policy);
65     /** Static function to check if given info will lead to a valid configuration
66      *
67      * Similar to CpuSubKernel::configure()
68      *
69      * @return a status
70      */
71     static Status validate(const ITensorInfo *src0, const ITensorInfo *src1, const ITensorInfo *dst, ConvertPolicy policy);
72 
73     // Inherited methods overridden:
74     void        run_op(ITensorPack &tensors, const Window &window, const ThreadInfo &info) override;
75     const char *name() const override;
76 
77     /** Return minimum workload size of the relevant kernel
78      *
79      * @param[in] platform     The CPU platform used to create the context.
80      * @param[in] thread_count Number of threads in the execution.
81      *
82      * @return[out] mws Minimum workload size for requested configuration.
83      */
84     size_t get_mws(const CPUInfo &platform, size_t thread_count) const override;
85 
86     struct SubKernel
87     {
88         const char                                  *name;
89         const CpuSubKernelDataTypeISASelectorDataPtr is_selected;
90         SubKernelPtr                                 ukernel;
91     };
92 
93     static const std::vector<SubKernel> &get_available_kernels();
94 
get_split_dimension()95     size_t get_split_dimension() const
96     {
97         return _split_dimension;
98     }
99 
100 private:
101     ConvertPolicy _policy{};
102     SubKernelPtr  _run_method{ nullptr };
103     std::string   _name{};
104     size_t        _split_dimension{ Window::DimY };
105 };
106 } // namespace kernels
107 } // namespace cpu
108 } // namespace arm_compute
109 #endif /* ARM_COMPUTE_CPU_SUB_KERNEL_H */
110