Compute Library
 21.11
CpuAddKernel.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_CPU_ADD_KERNEL_H
25 #define ARM_COMPUTE_CPU_ADD_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 addition between two tensors */
37 class CpuAddKernel : public ICpuKernel
38 {
39 public:
40  CpuAddKernel() = default;
42  /** Initialise the kernel's input, dst and border mode.
43  *
44  * Valid configurations (src0,src1) -> dst :
45  *
46  * - (U8,U8) -> U8
47  * - (S16,S16) -> S16
48  * - (S32,S32) -> S32
49  * - (F16,F16) -> F16
50  * - (F32,F32) -> F32
51  * - (QASYMM8,QASYMM8) -> QASYMM8
52  * - (QASYMM8_SIGNED,QASYMM8_SIGNED) -> QASYMM8_SIGNED
53  * - (QSYMM16,QSYMM16) -> QSYMM16
54  *
55  * @param[in] src0 First input tensor info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/F16/S32/F32
56  * @param[in] src1 Second input tensor info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/F16/S32/F32
57  * @param[out] dst The dst tensor info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/F16/S32/F32.
58  * @param[in] policy Overflow policy.
59  */
60  void configure(const ITensorInfo *src0, const ITensorInfo *src1, ITensorInfo *dst, ConvertPolicy policy);
61  /** Static function to check if given info will lead to a valid configuration
62  *
63  * Similar to CpuAddKernel::configure()
64  *
65  * @return a status
66  */
67  static Status validate(const ITensorInfo *src0, const ITensorInfo *src1, const ITensorInfo *dst, ConvertPolicy policy);
68 
69  // Inherited methods overridden:
70  void run_op(ITensorPack &tensors, const Window &window, const ThreadInfo &info) override;
71  const char *name() const override;
72 
73  /** Return minimum workload size of the relevant kernel
74  *
75  * @param[in] platform The CPU platform used to create the context.
76  * @param[in] thread_count Number of threads in the execution.
77  *
78  * @return[out] small_network_mws Minimum workload size for requsted configuration.
79  */
80  size_t get_mws(const CPUInfo &platform, size_t thread_count) const override;
81 
82 private:
84 
85 private:
86  ConvertPolicy _policy{};
87  AddKernelPtr _run_method{ nullptr };
88  std::string _name{};
89 };
90 } // namespace kernels
91 } // namespace cpu
92 } // namespace arm_compute
93 #endif /* ARM_COMPUTE_CPU_ADD_KERNEL_H */
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
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
decltype(strategy::transforms) typedef type
Copyright (c) 2017-2021 Arm Limited.
void run_op(ITensorPack &tensors, const Window &window, const ThreadInfo &info) override
Execute the kernel on the passed window.
Interface for the kernel to perform addition between two tensors.
Definition: CpuAddKernel.h:37
size_t get_mws(const CPUInfo &platform, size_t thread_count) const override
Return minimum workload size of the relevant kernel.
const char * name() const override
Name of the kernel.
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
Information about executing thread and CPU.
Definition: CPPTypes.h:158
static Status validate(const ITensorInfo *src0, const ITensorInfo *src1, const ITensorInfo *dst, ConvertPolicy policy)
Static function to check if given info will lead to a valid configuration.
void configure(const ITensorInfo *src0, const ITensorInfo *src1, ITensorInfo *dst, ConvertPolicy policy)
Initialise the kernel's input, dst and border mode.
Tensor packing service.
Definition: ITensorPack.h:39
Describe a multidimensional execution window.
Definition: Window.h:39
ConvertPolicy
Policy to handle integer overflow.
Definition: Types.h:391