diff options
| author | Michele Di Giorgio <michele.digiorgio@arm.com> | 2018-02-02 14:28:15 +0000 |
|---|---|---|
| committer | Anthony Barbier <anthony.barbier@arm.com> | 2018-11-02 16:47:18 +0000 |
| commit | 7df35411251c2b8c3eca429447873858e42188b0 (patch) | |
| tree | cbb4936b08a757e1532220bbab8122bd9940060c /arm_compute | |
| parent | ced7a8d0b4fe77d750a1e55883d5886ad9760f3b (diff) | |
| download | ComputeLibrary-7df35411251c2b8c3eca429447873858e42188b0.tar.gz | |
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 <anthony.barbier@arm.com>
Tested-by: Jenkins <bsgcomp@arm.com>
Diffstat (limited to 'arm_compute')
| -rw-r--r-- | arm_compute/runtime/CL/functions/CLArithmeticAddition.h | 10 |
1 files changed, 6 insertions, 4 deletions
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 |