aboutsummaryrefslogtreecommitdiff
path: root/arm_compute/core/NEON/kernels/NEArithmeticAdditionKernel.h
diff options
context:
space:
mode:
authorPablo Tello <pablo.tello@arm.com>2017-07-14 14:59:01 +0100
committerAnthony Barbier <anthony.barbier@arm.com>2018-09-17 14:16:42 +0100
commit04b741277fb6f775a44aa1d06b574c94d8559050 (patch)
treee49a7e9ac31e9eab26e308a48391915b57c352c5 /arm_compute/core/NEON/kernels/NEArithmeticAdditionKernel.h
parentb6c8d24042616341c1fbca6e255a69561c73fedf (diff)
downloadComputeLibrary-04b741277fb6f775a44aa1d06b574c94d8559050.tar.gz
COMPMID-421: Update NEArithmeticAdditionKernel documentation.
Change-Id: I4979a5d472384706d643879b6b1064313e31eee7 Reviewed-on: http://mpd-gerrit.cambridge.arm.com/80685 Tested-by: Kaizen <jeremy.johnson+kaizengerrit@arm.com> Reviewed-by: Anthony Barbier <anthony.barbier@arm.com>
Diffstat (limited to 'arm_compute/core/NEON/kernels/NEArithmeticAdditionKernel.h')
-rw-r--r--arm_compute/core/NEON/kernels/NEArithmeticAdditionKernel.h20
1 files changed, 16 insertions, 4 deletions
diff --git a/arm_compute/core/NEON/kernels/NEArithmeticAdditionKernel.h b/arm_compute/core/NEON/kernels/NEArithmeticAdditionKernel.h
index 7ad5893b70..e28ad67ca4 100644
--- a/arm_compute/core/NEON/kernels/NEArithmeticAdditionKernel.h
+++ b/arm_compute/core/NEON/kernels/NEArithmeticAdditionKernel.h
@@ -50,9 +50,21 @@ public:
/** Initialise the kernel's input, output and border mode.
*
+ * Valid configurations (Input1,Input2) -> Output :
+ *
+ * - (U8,U8) -> U8
+ * - (QS8,QS8) -> QS8
+ * - (U8,U8) -> S16
+ * - (S16,U8) -> S16
+ * - (U8,S16) -> S16
+ * - (S16,S16) -> S16
+ * - (QS16,QS16) -> QS16
+ * - (F16,F16) -> F16
+ * - (F32,F32) -> F32
+ *
* @param[in] input1 An input tensor. Data types supported: U8/QS8/QS16/S16/F16/F32
- * @param[in] input2 An input tensor. Data types supported: U8, QS8 (only if @p input1 is QS8), QS16 (only if @p input1 is QS16), S16/F16 (only if @p input1 is F16), F32 (only if @p input1 is F32).
- * @param[out] output The output tensor. Data types supported: U8 (Only if both inputs are U8), QS8 (only if both inputs are QS8), QS16 (only if both inputs are QS16), S16/F16 (only if @p input1 is F16), F32 (only if both inputs are F32).
+ * @param[in] input2 An input tensor. Data types supported: U8/QS8/QS16/S16/F16/F32
+ * @param[out] output The output tensor. Data types supported: U8/QS8/QS16/S16/F16/F32.
* @param[in] policy Overflow policy.
*/
void configure(const ITensor *input1, const ITensor *input2, ITensor *output, ConvertPolicy policy);
@@ -64,8 +76,8 @@ private:
/** Common signature for all the specialised add functions
*
* @param[in] input1 An input tensor. Data types supported: U8/QS8/QS16/S16/F16/F32
- * @param[in] input2 An input tensor. Data types supported: U8, QS8 (only if @p input1 is QS8), QS16 (only if @p input1 is QS16), S16/F16 (only if @p input1 is F16), F32 (only if @p input1 is F32).
- * @param[out] output The output tensor. Data types supported: U8 (Only if both inputs are U8), QS8 (only if both inputs are QS8), QS16 (only if both inputs are QS16), S16/F16 (only if @p input1 is F16), F32 (only if both inputs are F32).
+ * @param[in] input2 An input tensor. Data types supported: U8/QS8/QS16/S16/F16/F32
+ * @param[out] output The output tensor. Data types supported: U8/QS8/QS16/S16/F16/F32.
* @param[in] window Region on which to execute the kernel.
*/
using AddFunction = void(const ITensor *input1, const ITensor *input2, ITensor *output, const Window &window);