From 7df35411251c2b8c3eca429447873858e42188b0 Mon Sep 17 00:00:00 2001 From: Michele Di Giorgio Date: Fri, 2 Feb 2018 14:28:15 +0000 Subject: COMPMID-792: Update doctrings of CL kernels supporting broadcast operations Change-Id: I71146a83c67c4b193ef1e79d78bd80f9449781e2 Reviewed-on: https://eu-gerrit-1.euhpc.arm.com/118748 Reviewed-by: Anthony Barbier Tested-by: Jenkins --- arm_compute/runtime/CL/functions/CLArithmeticAddition.h | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) (limited to 'arm_compute/runtime') diff --git a/arm_compute/runtime/CL/functions/CLArithmeticAddition.h b/arm_compute/runtime/CL/functions/CLArithmeticAddition.h index 921738d0c2..5b2fc8c145 100644 --- a/arm_compute/runtime/CL/functions/CLArithmeticAddition.h +++ b/arm_compute/runtime/CL/functions/CLArithmeticAddition.h @@ -41,10 +41,12 @@ class CLArithmeticAddition : public ICLSimpleFunction public: /** Initialise the kernel's inputs, output and convertion policy. * - * @param[in] input1 First tensor input. Data types supported: U8/QS8/QS16/S16/F16/F32. - * @param[in] input2 Second tensor input. Data types supported: U8, QS8 (only if @p input1 is QS8), QS16 (only if @p input1 is QS16), S16/F16/F32. - * @param[out] output 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/F32. - * @param[in] policy Policy to use to handle overflow. + * @param[in, out] input1 First tensor input. Data types supported: U8/QS8/QS16/S16/F16/F32. + * The input tensor is [in, out] because its TensorInfo might be modified inside the kernel in case of broadcasting of dimension 0. + * @param[in, out] input2 Second tensor input. Data types supported: U8, QS8 (only if @p input1 is QS8), QS16 (only if @p input1 is QS16), S16/F16/F32. + * The input tensor is [in, out] because its TensorInfo might be modified inside the kernel in case of broadcasting of dimension 0. + * @param[out] output 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/F32. + * @param[in] policy Policy to use to handle overflow. */ void configure(ICLTensor *input1, ICLTensor *input2, ICLTensor *output, ConvertPolicy policy); /** Static function to check if given info will lead to a valid configuration of @ref CLArithmeticAddition -- cgit v1.2.1