Correcting the comments in equal and notequal cl (#3627)

This patch will corrects the comments in equal and notequal cl
And Adds the missing comments.

Signed-off-by: shubham <shub98.gupta@samsung.com>

diff --git a/libs/ARMComputeEx/src/core/CL/cl_kernels/equal.cl b/libs/ARMComputeEx/src/core/CL/cl_kernels/equal.cl
index 9bd754f..74bbd6c 100644 (file)
--- a/libs/ARMComputeEx/src/core/CL/cl_kernels/equal.cl
+++ b/libs/ARMComputeEx/src/core/CL/cl_kernels/equal.cl
@@ -18,11 +18,11 @@
 
 /** Checks if values in both tensors are equal.
  *
- * @attention Data type can be passed using the -DDATA_TYPE_IN compile flag, e.g. -DDATA_TYPE_IN=float
+ * @attention The input and output data types need to be passed at compile time using -DDATA_TYPE_IN, -DDATA_TYPE_OUT,
+ * e.g. -DDATA_TYPE_IN=float, -DDATA_TYPE_OUT = uchar
  * @attention Vector size should be given as a preprocessor argument using -DVEC_SIZE=size. e.g. -DVEC_SIZE=16
- * @note Can only take floating point data types.
  *
- * @param[in]  input1_ptr                            Pointer to the source tensor.
+ * @param[in]  input1_ptr                            Pointer to the source tensor. Supported data types: U8/S8/U16/S16/F16/U32/S32/F32
  * @param[in]  input1_stride_x                       Stride of the source tensor in X dimension (in bytes)
  * @param[in]  input1_step_x                         input1_stride_x * number of elements along X processed per workitem(in bytes)
  * @param[in]  input1_stride_y                       Stride of the source tensor in Y dimension (in bytes)
@@ -31,7 +31,7 @@
  * @param[in]  input1_step_z                         input1_stride_z * number of elements along Z processed per workitem(in bytes)
  * @param[in]  input1_offset_first_element_in_bytes  The offset of the first element in the source tensor
  *
- * @param[in]  input2_ptr                            Pointer to the source tensor.
+ * @param[in]  input2_ptr                            Pointer to the source tensor. Supported data types: U8/S8/U16/S16/F16/U32/S32/F32
  * @param[in]  input2_stride_x                       Stride of the source tensor in X dimension (in bytes)
  * @param[in]  input2_step_x                         input2_stride_x * number of elements along X processed per workitem(in bytes)
  * @param[in]  input2_stride_y                       Stride of the source tensor in Y dimension (in bytes)
@@ -40,13 +40,14 @@
  * @param[in]  input2_step_z                         input2_stride_z * number of elements along Z processed per workitem(in bytes)
  * @param[in]  input2_offset_first_element_in_bytes  The offset of the first element in the source tensor
  *
- * @param[out] output_ptr                           Pointer to the destination tensor.
+ * @param[out] output_ptr                           Pointer to the destination tensor. Supported data types: QASYMM8
  * @param[in]  output_stride_x                      Stride of the destination tensor in X dimension (in bytes)
  * @param[in]  output_step_x                        output_stride_x * number of elements along X processed per workitem(in bytes)
  * @param[in]  output_stride_y                      Stride of the destination tensor in Y dimension (in bytes)
  * @param[in]  output_step_y                        output_stride_y * number of elements along Y processed per workitem(in bytes)
  * @param[in]  output_stride_z                      Stride of the destination tensor in Z dimension (in bytes)
  * @param[in]  output_step_z                        output_stride_z * number of elements along Z processed per workitem(in bytes)
+ * @param[in]  output_offset_first_element_in_bytes The offset of the first element in the destination image
  */
 __kernel void equal(
     TENSOR3D_DECLARATION(input1),

diff --git a/libs/ARMComputeEx/src/core/CL/cl_kernels/equal_quantized.cl b/libs/ARMComputeEx/src/core/CL/cl_kernels/equal_quantized.cl
index 1cffc86..a29398e 100644 (file)
--- a/libs/ARMComputeEx/src/core/CL/cl_kernels/equal_quantized.cl
+++ b/libs/ARMComputeEx/src/core/CL/cl_kernels/equal_quantized.cl
@@ -18,12 +18,10 @@
 #define SUB(x, y) (x) - (y)
 
 /** Checks if values in both tensors are equal.
- *
- * @attention Data type can be passed using the -DDATA_TYPE_IN compile flag, e.g. -DDATA_TYPE_IN=float
+ * @attention Offset and Scale of both input should be given as a preprocessor argument using -DOFFSET_IN1=int, -DOFFSET_IN2=int, -DSCALE_IN1=float and -DSCALE_IN2=float. e.g. -DOFFSET_IN1=1, -DOFFSET_IN2=0, -DSCALE_IN1=0.5, -DSCALE_IN2=0.5
  * @attention Vector size should be given as a preprocessor argument using -DVEC_SIZE=size. e.g. -DVEC_SIZE=16
- * @note Can only take floating point data types.
  *
- * @param[in]  input1_ptr                            Pointer to the source tensor.
+ * @param[in]  input1_ptr                            Pointer to the source tensor. Supported data types: QASYMM8
  * @param[in]  input1_stride_x                       Stride of the source tensor in X dimension (in bytes)
  * @param[in]  input1_step_x                         input1_stride_x * number of elements along X processed per workitem(in bytes)
  * @param[in]  input1_stride_y                       Stride of the source tensor in Y dimension (in bytes)
@@ -32,7 +30,7 @@
  * @param[in]  input1_step_z                         input1_stride_z * number of elements along Z processed per workitem(in bytes)
  * @param[in]  input1_offset_first_element_in_bytes  The offset of the first element in the source tensor
  *
- * @param[in]  input2_ptr                            Pointer to the source tensor.
+ * @param[in]  input2_ptr                            Pointer to the source tensor. Supported data types: QASYMM8
  * @param[in]  input2_stride_x                       Stride of the source tensor in X dimension (in bytes)
  * @param[in]  input2_step_x                         input2_stride_x * number of elements along X processed per workitem(in bytes)
  * @param[in]  input2_stride_y                       Stride of the source tensor in Y dimension (in bytes)
@@ -41,7 +39,7 @@
  * @param[in]  input2_step_z                         input2_stride_z * number of elements along Z processed per workitem(in bytes)
  * @param[in]  input2_offset_first_element_in_bytes  The offset of the first element in the source tensor
  *
- * @param[out] output_ptr                           Pointer to the destination tensor.
+ * @param[out] output_ptr                           Pointer to the destination tensor. Supported data types: QASYMM8
  * @param[in]  output_stride_x                      Stride of the destination tensor in X dimension (in bytes)
  * @param[in]  output_step_x                        output_stride_x * number of elements along X processed per workitem(in bytes)
  * @param[in]  output_stride_y                      Stride of the destination tensor in Y dimension (in bytes)

diff --git a/libs/ARMComputeEx/src/core/CL/cl_kernels/notequal.cl b/libs/ARMComputeEx/src/core/CL/cl_kernels/notequal.cl
index 3f096c1..49ab39d 100644 (file)
--- a/libs/ARMComputeEx/src/core/CL/cl_kernels/notequal.cl
+++ b/libs/ARMComputeEx/src/core/CL/cl_kernels/notequal.cl
@@ -18,11 +18,11 @@
 
 /** Checks if values in both tensors are not equal.
  *
- * @attention Data type can be passed using the -DDATA_TYPE_IN compile flag, e.g. -DDATA_TYPE_IN=float
+ * @attention The input and output data types need to be passed at compile time using -DDATA_TYPE_IN, -DDATA_TYPE_OUT,
+ * e.g. -DDATA_TYPE_IN=float, -DDATA_TYPE_OUT = uchar
  * @attention Vector size should be given as a preprocessor argument using -DVEC_SIZE=size. e.g. -DVEC_SIZE=16
- * @note Can only take floating point data types.
  *
- * @param[in]  input1_ptr                            Pointer to the source tensor.
+ * @param[in]  input1_ptr                            Pointer to the source tensor. Supported data types: U8/S8/U16/S16/F16/U32/S32/F32
  * @param[in]  input1_stride_x                       Stride of the source tensor in X dimension (in bytes)
  * @param[in]  input1_step_x                         input1_stride_x * number of elements along X processed per workitem(in bytes)
  * @param[in]  input1_stride_y                       Stride of the source tensor in Y dimension (in bytes)
@@ -31,7 +31,7 @@
  * @param[in]  input1_step_z                         input1_stride_z * number of elements along Z processed per workitem(in bytes)
  * @param[in]  input1_offset_first_element_in_bytes  The offset of the first element in the source tensor
  *
- * @param[in]  input2_ptr                            Pointer to the source tensor.
+ * @param[in]  input2_ptr                            Pointer to the source tensor. Supported data types: U8/S8/U16/S16/F16/U32/S32/F32
  * @param[in]  input2_stride_x                       Stride of the source tensor in X dimension (in bytes)
  * @param[in]  input2_step_x                         input2_stride_x * number of elements along X processed per workitem(in bytes)
  * @param[in]  input2_stride_y                       Stride of the source tensor in Y dimension (in bytes)
@@ -40,13 +40,14 @@
  * @param[in]  input2_step_z                         input2_stride_z * number of elements along Z processed per workitem(in bytes)
  * @param[in]  input2_offset_first_element_in_bytes  The offset of the first element in the source tensor
  *
- * @param[out] output_ptr                           Pointer to the destination tensor.
+ * @param[out] output_ptr                           Pointer to the destination tensor. Supported data types: QASYMM8
  * @param[in]  output_stride_x                      Stride of the destination tensor in X dimension (in bytes)
  * @param[in]  output_step_x                        output_stride_x * number of elements along X processed per workitem(in bytes)
  * @param[in]  output_stride_y                      Stride of the destination tensor in Y dimension (in bytes)
  * @param[in]  output_step_y                        output_stride_y * number of elements along Y processed per workitem(in bytes)
  * @param[in]  output_stride_z                      Stride of the destination tensor in Z dimension (in bytes)
  * @param[in]  output_step_z                        output_stride_z * number of elements along Z processed per workitem(in bytes)
+ * @param[in]  output_offset_first_element_in_bytes The offset of the first element in the destination image
  */
 __kernel void notequal(
     TENSOR3D_DECLARATION(input1),