Compute Library
 21.02
NEArithmeticSubtraction.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_NEARITHMETICSUBTRACTION_H
25 #define ARM_COMPUTE_NEARITHMETICSUBTRACTION_H
26 
27 #include "arm_compute/core/Types.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  */
44 {
45 public:
46  /** Default Constructor */
48  /** Default Destructor */
50  /** Prevent instances of this class from being copied (As this class contains pointers) */
52  /** Default move constructor */
54  /** Prevent instances of this class from being copied (As this class contains pointers) */
56  /** Default move assignment operator */
58  /** Initialise the kernel's inputs, output and conversion policy.
59  *
60  * @param[in] input1 First tensor input. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/QSYMM16/S16/S32/F16/F32
61  * @param[in] input2 Second tensor input. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/QSYMM16/S16/S32/F16/F32
62  * @param[out] output Output tensor. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/QSYMM16/S16/S32/F16/F32
63  * @param[in] policy Policy to use to handle overflow. Convert policy cannot be WRAP if datatype is quantized.
64  * @param[in] act_info (Optional) Activation layer information in case of a fused activation. Currently not supported.
65  */
66  void configure(const ITensor *input1, const ITensor *input2, ITensor *output, ConvertPolicy policy, const ActivationLayerInfo &act_info = ActivationLayerInfo());
67  /** Static function to check if given info will lead to a valid configuration of @ref NEArithmeticSubtraction
68  *
69  * @param[in] input1 First tensor input. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/S32/F16/F32
70  * @param[in] input2 Second tensor input. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/S32/F16/F32
71  * @param[in] output Output tensor. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/S32/F16/F32
72  * @param[in] policy Policy to use to handle overflow. Convert policy cannot be WRAP if datatype is quantized.
73  * @param[in] act_info (Optional) Activation layer information in case of a fused activation. Currently not supported.
74  *
75  * @return a status
76  */
77  static Status validate(const ITensorInfo *input1, const ITensorInfo *input2, const ITensorInfo *output, ConvertPolicy policy, const ActivationLayerInfo &act_info = ActivationLayerInfo());
78 
79  // Inherited methods overridden:
80  void run() override;
81 
82 private:
83  struct Impl;
84  std::unique_ptr<Impl> _impl;
85 };
86 } // namespace arm_compute
87 #endif /* ARM_COMPUTE_NEARITHMETICSUBTRACTION_H */
~NEArithmeticSubtraction()
Default Destructor.
Base class for all functions.
Definition: IFunction.h:30
void run() override
Run the kernels contained in the function.
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Activation Layer Information class.
Definition: Types.h:1550
Interface for Neon tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2021 Arm Limited.
Basic function to run cpu::kernels::CpuSubKernel.
void configure(const ITensor *input1, const ITensor *input2, ITensor *output, ConvertPolicy policy, const ActivationLayerInfo &act_info=ActivationLayerInfo())
Initialise the kernel&#39;s inputs, output and conversion policy.
NEArithmeticSubtraction & operator=(const NEArithmeticSubtraction &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
ConvertPolicy
Policy to handle overflow.
Definition: Types.h:385
static Status validate(const ITensorInfo *input1, const ITensorInfo *input2, const ITensorInfo *output, ConvertPolicy policy, const ActivationLayerInfo &act_info=ActivationLayerInfo())
Static function to check if given info will lead to a valid configuration of NEArithmeticSubtraction...