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