xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/runtime/NEON/functions/NEArithmeticAddition.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
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_NEARITHMETICADDITION_H
25 #define ARM_COMPUTE_NEARITHMETICADDITION_H
26 
27 #include "arm_compute/core/Types.h"
28 #include "arm_compute/runtime/IFunction.h"
29 #include <memory>
30 
31 namespace arm_compute
32 {
33 class ITensor;
34 class ITensorInfo;
35 
36 /** Basic function to run @ref cpu::kernels::CpuAddKernel */
37 class NEArithmeticAddition : public IFunction
38 {
39 public:
40     /** Default Constructor */
41     NEArithmeticAddition();
42     /** Default Destructor */
43     ~NEArithmeticAddition();
44     /** Prevent instances of this class from being copied (As this class contains pointers) */
45     NEArithmeticAddition(const NEArithmeticAddition &) = delete;
46     /** Default move constructor */
47     NEArithmeticAddition(NEArithmeticAddition &&);
48     /** Prevent instances of this class from being copied (As this class contains pointers) */
49     NEArithmeticAddition &operator=(const NEArithmeticAddition &) = delete;
50     /** Default move assignment operator */
51     NEArithmeticAddition &operator=(NEArithmeticAddition &&);
52     /** Initialise the kernel's inputs, output and conversion policy.
53      *
54      * Valid data layouts:
55      * - All
56      *
57      * Valid data type configurations:
58      * |src0           |src1           |dst            |
59      * |:--------------|:--------------|:--------------|
60      * |QASYMM8        |QASYMM8        |QASYMM8        |
61      * |QASYMM8_SIGNED |QASYMM8_SIGNED |QASYMM8_SIGNED |
62      * |QSYMM16        |QSYMM16        |QASYMM16       |
63      * |QSYMM16        |QSYMM16        |S32            |
64      * |U8             |U8             |U8             |
65      * |S16            |S16            |S16            |
66      * |S32            |S32            |S32            |
67      * |F16            |F16            |F16            |
68      * |F32            |F32            |F32            |
69      *
70      * @param[in]  input1   First tensor input. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/F16/S32/F32
71      * @param[in]  input2   Second tensor input. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/F16/S32/F32
72      * @param[out] output   Output tensor. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/F16/S32/F32
73      * @param[in]  policy   Policy to use to handle overflow.
74      * @param[in]  act_info (Optional) Activation layer information in case of a fused activation. Currently not supported.
75      */
76     void configure(const ITensor *input1, const ITensor *input2, ITensor *output, ConvertPolicy policy, const ActivationLayerInfo &act_info = ActivationLayerInfo());
77     /** Static function to check if given info will lead to a valid configuration of @ref NEArithmeticAddition
78      *
79      * @param[in] input1   First tensor input info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/F16/S32/F32
80      * @param[in] input2   Second tensor input info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/F16/S32/F32
81      * @param[in] output   Output tensor info. Data types supported: U8/SQASYMM8/QASYMM8_SIGNED/S16/QSYMM16/F16/S32/F32
82      * @param[in] policy   Policy to use to handle overflow
83      * @param[in] act_info (Optional) Activation layer information in case of a fused activation. Currently not supported.
84      *
85      * @return a status
86      */
87     static Status validate(const ITensorInfo *input1, const ITensorInfo *input2, const ITensorInfo *output, ConvertPolicy policy, const ActivationLayerInfo &act_info = ActivationLayerInfo());
88 
89     // Inherited methods overridden:
90     void run() override;
91 
92 private:
93     struct Impl;
94     std::unique_ptr<Impl> _impl;
95 };
96 } // namespace arm_compute
97 #endif /* ARM_COMPUTE_NEARITHMETICADDITION_H */
98