xref: /aosp_15_r20/external/ComputeLibrary/src/cpu/operators/CpuAdd.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2021-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_ADD_H
25 #define ARM_COMPUTE_CPU_ADD_H
26 
27 #include "src/cpu/ICpuOperator.h"
28 
29 namespace arm_compute
30 {
31 namespace cpu
32 {
33 /** Basic function to run @ref kernels::CpuAddKernel */
34 class CpuAdd : public ICpuOperator
35 {
36 public:
37     /** Initialise the kernel's input, dst and border mode.
38      *
39      * Valid configurations (src0,src1) -> dst :
40      *
41      *   - (U8,U8)           -> U8
42      *   - (S16,S16)         -> S16
43      *   - (S32,S32)         -> S32
44      *   - (F16,F16)         -> F16
45      *   - (F32,F32)         -> F32
46      *   - (QASYMM8,QASYMM8) -> QASYMM8
47      *   - (QASYMM8_SIGNED,QASYMM8_SIGNED) -> QASYMM8_SIGNED
48      *   - (QSYMM16,QSYMM16) -> QSYMM16
49      *
50      * @param[in]  src0     First input tensor info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/F16/S32/F32
51      * @param[in]  src1     Second input tensor info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/F16/S32/F32
52      * @param[out] dst      The dst tensor info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/F16/S32/F32.
53      * @param[in]  policy   Overflow policy.
54      * @param[in]  act_info (Optional) Activation layer information in case of a fused activation. Currently not supported.
55      *
56      */
57     void configure(const ITensorInfo *src0, const ITensorInfo *src1, ITensorInfo *dst, ConvertPolicy policy, const ActivationLayerInfo &act_info = ActivationLayerInfo());
58     /** Static function to check if given info will lead to a valid configuration
59      *
60      * Similar to @ref CpuAdd::configure()
61      *
62      * @return a status
63      */
64     static Status validate(const ITensorInfo *src0, const ITensorInfo *src1, const ITensorInfo *dst, ConvertPolicy policy, const ActivationLayerInfo &act_info = ActivationLayerInfo());
65 
66     // Inherited methods overridden:
67     void run(ITensorPack &tensors) override;
68 };
69 } // namespace cpu
70 } // namespace arm_compute
71 #endif /* ARM_COMPUTE_CPU_ADD_H */
72