xref: /aosp_15_r20/external/ComputeLibrary/src/cpu/operators/CpuSub.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_SUB_H
25 #define ARM_COMPUTE_CPU_SUB_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::CpuSubKernel */
34 class CpuSub : public ICpuOperator
35 {
36 public:
37     /** Initialise the kernel's inputs, dst and conversion policy.
38      *
39      * Valid configurations (src0,src1) -> dst :
40      *
41      *   - (U8,U8)                          -> U8
42      *   - (QASYMM8, QASYMM8)               -> QASYMM8
43      *   - (QASYMM8_SIGNED, QASYMM8_SIGNED) -> QASYMM8_SIGNED
44      *   - (S16,S16)                        -> S16
45      *   - (S32,S32)                        -> S32
46      *   - (F16,F16)                        -> F16
47      *   - (F32,F32)                        -> F32
48      *
49      * @param[in]  src0     First tensor input info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/QSYMM16/S16/S32/F16/F32
50      * @param[in]  src1     Second tensor input info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/QSYMM16/S16/S32/F16/F32
51      * @param[out] dst      Output tensor info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/QSYMM16/S16/S32/F16/F32
52      * @param[in]  policy   Policy to use to handle overflow. Convert policy cannot be WRAP if datatype is quantized.
53      * @param[in]  act_info (Optional) Activation layer information in case of a fused activation. Currently not supported.
54      */
55     void configure(const ITensorInfo *src0, const ITensorInfo *src1, ITensorInfo *dst, ConvertPolicy policy, const ActivationLayerInfo &act_info = ActivationLayerInfo());
56     /** Static function to check if given info will lead to a valid configuration
57      *
58      * Similar to @ref CpuSub::configure()
59      *
60      * @return a status
61      */
62     static Status validate(const ITensorInfo *src0, const ITensorInfo *src1, const ITensorInfo *dst, ConvertPolicy policy, const ActivationLayerInfo &act_info = ActivationLayerInfo());
63 
64     // Inherited methods overridden:
65     void run(ITensorPack &tensors) override;
66 };
67 } // namespace cpu
68 } // namespace arm_compute
69 #endif /* ARM_COMPUTE_CPU_SUB_H */