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