From 2eb5d16b839cbc28c6cb7f0de7a0bf15290b425a Mon Sep 17 00:00:00 2001 From: Georgios Pinitas Date: Fri, 2 Jul 2021 09:01:49 +0100 Subject: Align kernel/operator header layout - Redirect validate documentation to configure - Align header names - Align class layout Signed-off-by: Georgios Pinitas Change-Id: Ia40f67383826a66e9f9a33745d66805551e31a3a Reviewed-on: https://review.mlplatform.org/c/ml/ComputeLibrary/+/5897 Comments-Addressed: Arm Jenkins Tested-by: Arm Jenkins Reviewed-by: Michele Di Giorgio --- src/runtime/gpu/cl/operators/ClActivation.h | 8 +--- src/runtime/gpu/cl/operators/ClAdd.h | 24 +----------- src/runtime/gpu/cl/operators/ClCast.h | 2 - src/runtime/gpu/cl/operators/ClConcatenate.cpp | 7 ---- src/runtime/gpu/cl/operators/ClConcatenate.h | 19 +++------ .../cl/operators/ClConvertFullyConnectedWeights.h | 15 +++----- src/runtime/gpu/cl/operators/ClCopy.h | 8 +--- src/runtime/gpu/cl/operators/ClCrop.h | 21 +++------- src/runtime/gpu/cl/operators/ClDequantize.h | 2 - src/runtime/gpu/cl/operators/ClDirectConv2d.h | 1 - .../gpu/cl/operators/ClElementwiseOperations.h | 45 +++++----------------- src/runtime/gpu/cl/operators/ClElementwiseUnary.h | 45 +++++++--------------- src/runtime/gpu/cl/operators/ClFill.h | 8 +--- src/runtime/gpu/cl/operators/ClFlatten.h | 2 - src/runtime/gpu/cl/operators/ClFloor.h | 7 +--- src/runtime/gpu/cl/operators/ClLogicalNot.h | 5 +-- src/runtime/gpu/cl/operators/ClMul.h | 4 -- src/runtime/gpu/cl/operators/ClPRelu.h | 8 +--- src/runtime/gpu/cl/operators/ClPermute.h | 10 +---- src/runtime/gpu/cl/operators/ClQuantize.h | 2 - src/runtime/gpu/cl/operators/ClReshape.h | 8 +--- src/runtime/gpu/cl/operators/ClScale.h | 10 ++--- src/runtime/gpu/cl/operators/ClSoftmax.h | 8 ++-- src/runtime/gpu/cl/operators/ClSub.h | 24 +----------- src/runtime/gpu/cl/operators/ClTranspose.h | 7 +--- 25 files changed, 68 insertions(+), 232 deletions(-) (limited to 'src/runtime/gpu/cl/operators') diff --git a/src/runtime/gpu/cl/operators/ClActivation.h b/src/runtime/gpu/cl/operators/ClActivation.h index 235b826b87..82ef8ac63a 100644 --- a/src/runtime/gpu/cl/operators/ClActivation.h +++ b/src/runtime/gpu/cl/operators/ClActivation.h @@ -35,8 +35,6 @@ namespace opencl class ClActivation : public IClOperator { public: - /** Constructor */ - ClActivation() = default; /** Configure operator for a given list of arguments * * @param[in] compile_context The compile context to be used. @@ -45,11 +43,9 @@ public: * @param[in] activation_info Activation layer parameters. */ void configure(const ClCompileContext &compile_context, ITensorInfo *src, ITensorInfo *dst, const ActivationLayerInfo &activation_info); - /** Static function to check if given info will lead to a valid configuration of @ref ClActivation + /** Static function to check if given info will lead to a valid configuration * - * @param[in] src Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/QSYMM16/F16/F32. - * @param[in] dst Destination tensor info. Data type supported: same as @p src - * @param[in] act_info Activation layer information. + * Similar to @ref ClActivation::configure() * * @return a status */ diff --git a/src/runtime/gpu/cl/operators/ClAdd.h b/src/runtime/gpu/cl/operators/ClAdd.h index f751d8dc83..7b84a767d6 100644 --- a/src/runtime/gpu/cl/operators/ClAdd.h +++ b/src/runtime/gpu/cl/operators/ClAdd.h @@ -39,8 +39,6 @@ namespace opencl class ClAdd : public IClOperator { public: - /** Default Constructor */ - ClAdd() = default; /** Configure function for a given list of arguments. * * Valid configurations (src1,src2) -> dst : @@ -68,27 +66,9 @@ public: */ void configure(const ClCompileContext &compile_context, ITensorInfo *src1, ITensorInfo *src2, ITensorInfo *dst, ConvertPolicy policy, const ActivationLayerInfo &act_info = ActivationLayerInfo()); - /** Static function to check if given info will lead to a valid configuration of @ref ClAdd + /** Static function to check if given info will lead to a valid configuration * - * Valid configurations (src1,src2) -> dst : - * - * - (U8,U8) -> U8 - * - (U8,U8) -> S16 - * - (S16,U8) -> S16 - * - (U8,S16) -> S16 - * - (S16,S16) -> S16 - * - (S32,S32) -> S32 - * - (F16,F16) -> F16 - * - (F32,F32) -> F32 - * - (QASYMM8,QASYMM8) -> QASYMM8 - * - (QASYMM8_SIGNED,QASYMM8_SIGNED) -> QASYMM8_SIGNED - * - (QSYMM16,QSYMM16) -> QSYMM16 - * - * @param[in] src1 First source tensor info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/S32/F16/F32. - * @param[in] src2 Second source tensor info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/S32/F16/F32. - * @param[in] dst Destination tensor info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/S32/F16/F32. - * @param[in] policy Policy to use to handle overflow. - * @param[in] act_info (Optional) Activation layer information in case of a fused activation. + * Similar to @ref ClAdd::configure() * * @return a status */ diff --git a/src/runtime/gpu/cl/operators/ClCast.h b/src/runtime/gpu/cl/operators/ClCast.h index 69e028debd..107eb2bfe9 100644 --- a/src/runtime/gpu/cl/operators/ClCast.h +++ b/src/runtime/gpu/cl/operators/ClCast.h @@ -35,8 +35,6 @@ namespace opencl class ClCast : public IClOperator { public: - /** Constructor */ - ClCast() = default; /** Configure operator for a given list of arguments * * @note Input data type must be different than output data type. diff --git a/src/runtime/gpu/cl/operators/ClConcatenate.cpp b/src/runtime/gpu/cl/operators/ClConcatenate.cpp index 4385fcfaed..d3c05eae78 100644 --- a/src/runtime/gpu/cl/operators/ClConcatenate.cpp +++ b/src/runtime/gpu/cl/operators/ClConcatenate.cpp @@ -42,13 +42,6 @@ namespace arm_compute { namespace opencl { -ClConcatenate::ClConcatenate() - : _concat_kernels(), - _num_inputs(0), - _axis(Window::DimX) -{ -} - void ClConcatenate::configure(const CLCompileContext &compile_context, const std::vector &src_vector, ITensorInfo *dst, size_t axis) { ARM_COMPUTE_ERROR_ON(dst == nullptr); diff --git a/src/runtime/gpu/cl/operators/ClConcatenate.h b/src/runtime/gpu/cl/operators/ClConcatenate.h index 0d960a605c..fb1235b9be 100644 --- a/src/runtime/gpu/cl/operators/ClConcatenate.h +++ b/src/runtime/gpu/cl/operators/ClConcatenate.h @@ -44,8 +44,7 @@ namespace opencl class ClConcatenate : public IClOperator { public: - /** Default constructor */ - ClConcatenate(); + ClConcatenate() = default; /** Initialise the kernel's inputs vector and dst. * * @note Input and dst tensor dimensions preconditions defer depending on the concatenation axis. @@ -59,15 +58,9 @@ public: * @param[in] axis Concatenation axis. Supported underlying concatenation axis are 0, 1, 2 and 3. */ void configure(const ClCompileContext &compile_context, const std::vector &src_vector, ITensorInfo *dst, size_t axis); - /** Static function to check if given info will lead to a valid configuration of @ref ClConcatenate + /** Static function to check if given info will lead to a valid configuration * - * @note Input and dst tensor dimensions preconditions defer depending on the concatenation axis. - * @note Preconditions can be found respectively at @ref kernels::ClWidthConcatenateKernel, - * @ref kernels::ClHeightConcatenateKernel and @ref kernels::ClDepthConcatenateKernel. - * - * @param[in] src_vector The vectors containing all the tensors info to concatenate. Data types supported: All - * @param[in] dst Destination tensor info. Data types supported: same as @p src_vector. - * @param[in] axis Concatenation axis. Supported underlying concatenation axis are 0, 1, 2 and 3. + * Similar to @ref ClConcatenate::configure() * * @return a status */ @@ -77,9 +70,9 @@ public: void run(ITensorPack &tensors) override; private: - std::vector> _concat_kernels; - unsigned int _num_inputs; - unsigned int _axis; + std::vector> _concat_kernels{}; + unsigned int _num_inputs{ 0 }; + unsigned int _axis{ 0 }; }; } // namespace opencl } // namespace arm_comPUTE diff --git a/src/runtime/gpu/cl/operators/ClConvertFullyConnectedWeights.h b/src/runtime/gpu/cl/operators/ClConvertFullyConnectedWeights.h index efedc2fcb7..7ea35c5a8a 100644 --- a/src/runtime/gpu/cl/operators/ClConvertFullyConnectedWeights.h +++ b/src/runtime/gpu/cl/operators/ClConvertFullyConnectedWeights.h @@ -21,8 +21,8 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ -#ifndef ARM_COMPUTE_CL_CONVERTFULLYCONNECTEDWEIGHTS_H -#define ARM_COMPUTE_CL_CONVERTFULLYCONNECTEDWEIGHTS_H +#ifndef ARM_COMPUTE_CL_CONVERT_FULLYCONNECTED_WEIGHTS_H +#define ARM_COMPUTE_CL_CONVERT_FULLYCONNECTED_WEIGHTS_H #include "src/core/gpu/cl/ClCompileContext.h" #include "src/runtime/gpu/cl/IClOperator.h" @@ -35,8 +35,6 @@ namespace opencl class ClConvertFullyConnectedWeights : public IClOperator { public: - /** Constructor */ - ClConvertFullyConnectedWeights() = default; /** Initialise the kernel's inputs and outputs * * @param[in] compile_context The compile context to be used. @@ -46,12 +44,9 @@ public: * @param[in] data_layout The data layout the weights have been trained in. */ void configure(const CLCompileContext &compile_context, const ITensorInfo *src, ITensorInfo *dst, const TensorShape &original_src_shape, DataLayout data_layout); - /** Static function to check if given info will lead to a valid configuration of @ref kernels::ClConvertFullyConnectedWeightsKernel. + /** Static function to check if given info will lead to a valid configuration * - * @param[in] src First tensor src info. Data types supported: All. - * @param[in] dst Output tensor info. Data types supported: same as @p src. - * @param[in] original_src_shape Shape of the original src tensor (the one entering fully connected layer). - * @param[in] data_layout The data layout the weights have been trained in. + * Similar to @ref ClConvertFullyConnectedWeights::configure() * * @return a status */ @@ -59,4 +54,4 @@ public: }; } // namespace opencl } // namespace arm_compute -#endif /* ARM_COMPUTE_CL_CONVERTFULLYCONNECTEDWEIGHTS_H */ +#endif /* ARM_COMPUTE_CL_CONVERT_FULLYCONNECTED_WEIGHTS_H */ diff --git a/src/runtime/gpu/cl/operators/ClCopy.h b/src/runtime/gpu/cl/operators/ClCopy.h index 0b99676f65..e8ea8125eb 100644 --- a/src/runtime/gpu/cl/operators/ClCopy.h +++ b/src/runtime/gpu/cl/operators/ClCopy.h @@ -36,8 +36,6 @@ namespace opencl class ClCopy : public IClOperator { public: - /** Constructor */ - ClCopy() = default; /** Initialise the function's source and destination. * * @param[in] compile_context The compile context to be used. @@ -47,11 +45,9 @@ public: * */ void configure(const CLCompileContext &compile_context, ITensorInfo *src, ITensorInfo *dst, Window *dst_window = nullptr); - /** Static function to check if given info will lead to a valid configuration of @ref kernels::ClCopyKernel + /** Static function to check if given info will lead to a valid configuration * - * @param[in] src Source tensor info. Data types supported: All. - * @param[in] dst Output tensor info. Data types supported: Same as @p src. - * @param[in] dst_window (Optional) Window to be used in case only copying into part of a tensor. Default is nullptr. + * Similar to @ref ClCopy::configure() * * @return a status */ diff --git a/src/runtime/gpu/cl/operators/ClCrop.h b/src/runtime/gpu/cl/operators/ClCrop.h index acfbf14742..cca69d6d77 100644 --- a/src/runtime/gpu/cl/operators/ClCrop.h +++ b/src/runtime/gpu/cl/operators/ClCrop.h @@ -21,8 +21,8 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ -#ifndef ARM_COMPUTE_CL_COPY_H -#define ARM_COMPUTE_CL_COPY_H +#ifndef ARM_COMPUTE_CL_CROP_H +#define ARM_COMPUTE_CL_CROP_H #include "arm_compute/core/Window.h" #include "src/core/gpu/cl/ClCompileContext.h" @@ -36,8 +36,6 @@ namespace opencl class ClCrop : public IClOperator { public: - /** Constructor */ - ClCrop() = default; /** Initialise the function's source and destination. * * @note Supported tensor rank: up to 4 @@ -53,22 +51,15 @@ public: */ void configure(const CLCompileContext &compile_context, const ITensorInfo *src, ITensorInfo *dst, Coordinates2D start, Coordinates2D end, uint32_t batch_index, float extrapolation_value = 0, Window *dst_window = nullptr); - - /** Static function to check if given info will lead to a valid configuration of @ref kernels::ClCropKernel + /** Static function to check if given info will lead to a valid configuration * - * @note Supported tensor rank: up to 4 + * Similar to @ref ClCrop::configure() * - * @param[in] src Source tensor info. Data type supported: All. Data layouts supported: NHWC. - * @param[in] dst Destination tensor info. Data type supported: F32 - * @param[in] start Coordinates of where to start cropping the image. - * @param[in] end Coordinates of where to end cropping the image. - * @param[in] batch_index Fourth dimension index of the 3D image to crop in @p src. - * @param[in] extrapolation_value Value to be used for values outside of the image. Default is 0. - * @param[in] dst_window Output window to be used in case cropped image is being copied into a tensor. Default is nullptr. + * @return a status */ static Status validate(const ITensorInfo *src, const ITensorInfo *dst, Coordinates2D start, Coordinates2D end, uint32_t batch_index, float extrapolation_value = 0, Window *dst_window = nullptr); }; } // namespace opencl } // namespace arm_compute -#endif /* ARM_COMPUTE_CL_COPY_H */ +#endif /* ARM_COMPUTE_CL_CROP_H */ diff --git a/src/runtime/gpu/cl/operators/ClDequantize.h b/src/runtime/gpu/cl/operators/ClDequantize.h index 47fad3eeee..5bcdcb2113 100644 --- a/src/runtime/gpu/cl/operators/ClDequantize.h +++ b/src/runtime/gpu/cl/operators/ClDequantize.h @@ -35,8 +35,6 @@ namespace opencl class ClDequantize : public IClOperator { public: - /** Constructor */ - ClDequantize() = default; /** Set the input and output tensors. * * @param[in] compile_context The compile context to be used. diff --git a/src/runtime/gpu/cl/operators/ClDirectConv2d.h b/src/runtime/gpu/cl/operators/ClDirectConv2d.h index e069733fab..a2785b52e3 100644 --- a/src/runtime/gpu/cl/operators/ClDirectConv2d.h +++ b/src/runtime/gpu/cl/operators/ClDirectConv2d.h @@ -42,7 +42,6 @@ namespace opencl class ClDirectConv2d : public IClOperator { public: - /** Constructor */ ClDirectConv2d() = default; /** Set the src and dst tensors. * diff --git a/src/runtime/gpu/cl/operators/ClElementwiseOperations.h b/src/runtime/gpu/cl/operators/ClElementwiseOperations.h index b9ab1405c8..c01b107d97 100644 --- a/src/runtime/gpu/cl/operators/ClElementwiseOperations.h +++ b/src/runtime/gpu/cl/operators/ClElementwiseOperations.h @@ -39,8 +39,6 @@ namespace opencl class ClElementwiseDivision : public IClOperator { public: - /** Default Constructor */ - ClElementwiseDivision() = default; /** Configure function for a given list of arguments. * * @param[in] compile_context The compile context to be used. @@ -50,12 +48,9 @@ public: * @param[in] act_info (Optional) Activation layer information in case of a fused activation. */ void configure(const ClCompileContext &compile_context, ITensorInfo *src1, ITensorInfo *src2, ITensorInfo *dst, const ActivationLayerInfo &act_info = ActivationLayerInfo()); - /** Static function to check if given info will lead to a valid configuration of @ref ClElementwiseDivision + /** Static function to check if given info will lead to a valid configuration * - * @param[in] src1 First source tensor info. Data types supported: F16/F32. - * @param[in] src2 Second source tensor info. Data types supported: same as @p src1. - * @param[in] dst Destination tensor info. Data types supported: same as @p src1. - * @param[in] act_info (Optional) Activation layer information in case of a fused activation. + * Similar to @ref ClElementwiseDivision::configure() * * @return a status */ @@ -70,8 +65,6 @@ public: class ClElementwiseMax : public IClOperator { public: - /** Default Constructor */ - ClElementwiseMax() = default; /** Configure function for a given list of arguments. * * @param[in] compile_context The compile context to be used. @@ -81,12 +74,9 @@ public: * @param[in] act_info (Optional) Activation layer information in case of a fused activation. */ void configure(const ClCompileContext &compile_context, ITensorInfo *src1, ITensorInfo *src2, ITensorInfo *dst, const ActivationLayerInfo &act_info = ActivationLayerInfo()); - /** Static function to check if given info will lead to a valid configuration of @ref opencl::kernels::ClArithmeticKernel for max + /** Static function to check if given info will lead to a valid configuration * - * @param[in] src1 First source tensor info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/S32/U32/F16/F32. - * @param[in] src2 Second source tensor info. Data types supported: same as @p src1. - * @param[in] dst Destination tensor info. Data types supported: same as @p src1. - * @param[in] act_info (Optional) Activation layer information in case of a fused activation. + * Similar to @ref ClElementwiseMax::configure() * * @return a status */ @@ -101,8 +91,6 @@ public: class ClElementwiseMin : public IClOperator { public: - /** Default Constructor */ - ClElementwiseMin() = default; /** Configure function for a given list of arguments. * * @param[in] compile_context The compile context to be used. @@ -112,12 +100,9 @@ public: * @param[in] act_info (Optional) Activation layer information in case of a fused activation. */ void configure(const ClCompileContext &compile_context, ITensorInfo *src1, ITensorInfo *src2, ITensorInfo *dst, const ActivationLayerInfo &act_info = ActivationLayerInfo()); - /** Static function to check if given info will lead to a valid configuration of @ref opencl::kernels::ClArithmeticKernel for min + /** Static function to check if given info will lead to a valid configuration * - * @param[in] src1 First source tensor info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/S32/U32/F16/F32. - * @param[in] src2 Second source tensor info. Data types supported: same as @p src1. - * @param[in] dst Destination tensor info. Data types supported: same as @p src1. - * @param[in] act_info (Optional) Activation layer information in case of a fused activation. + * Similar to @ref ClElementwiseMin::configure() * * @return a status */ @@ -132,8 +117,6 @@ public: class ClElementwiseSquaredDiff : public IClOperator { public: - /** Default Constructor */ - ClElementwiseSquaredDiff() = default; /** Configure function for a given list of arguments. * * @param[in] compile_context The compile context to be used. @@ -143,12 +126,9 @@ public: * @param[in] act_info (Optional) Activation layer information in case of a fused activation. */ void configure(const ClCompileContext &compile_context, ITensorInfo *src1, ITensorInfo *src2, ITensorInfo *dst, const ActivationLayerInfo &act_info = ActivationLayerInfo()); - /** Static function to check if given info will lead to a valid configuration of @ref opencl::kernels::ClArithmeticKernel for squared difference + /** Static function to check if given info will lead to a valid configuration * - * @param[in] src1 First source tensor info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/F16/F32. - * @param[in] src2 Second source tensor info. Data types supported: same as @p src1. - * @param[in] dst Destination tensor info. Data types supported: same as @p src1. - * @param[in] act_info (Optional) Activation layer information in case of a fused activation. + * Similar to @ref ClElementwiseSquaredDiff::configure() * * @return a status */ @@ -163,8 +143,6 @@ public: class ClElementwisePower : public IClOperator { public: - /** Default Constructor */ - ClElementwisePower() = default; /** Configure function for a given list of arguments. * * @param[in] compile_context The compile context to be used. @@ -174,12 +152,9 @@ public: * @param[in] act_info (Optional) Activation layer information in case of a fused activation. */ void configure(const ClCompileContext &compile_context, ITensorInfo *src1, ITensorInfo *src2, ITensorInfo *dst, const ActivationLayerInfo &act_info = ActivationLayerInfo()); - /** Static function to check if given info will lead to a valid configuration of @ref opencl::kernels::ClArithmeticKernel for power + /** Static function to check if given info will lead to a valid configuration * - * @param[in] src1 First source tensor info. Data types supported: F16/F32. - * @param[in] src2 Second source tensor info. Data types supported: F16/F32. - * @param[in] dst Destination tensor info. Data types supported: F16/F32. - * @param[in] act_info (Optional) Activation layer information in case of a fused activation. + * Similar to @ref ClElementwisePower::configure() * * @return a status */ diff --git a/src/runtime/gpu/cl/operators/ClElementwiseUnary.h b/src/runtime/gpu/cl/operators/ClElementwiseUnary.h index b40e3e9a3b..b9acf6f5b8 100644 --- a/src/runtime/gpu/cl/operators/ClElementwiseUnary.h +++ b/src/runtime/gpu/cl/operators/ClElementwiseUnary.h @@ -35,8 +35,6 @@ namespace opencl class ClRsqrt : public IClOperator { public: - /** Constructor */ - ClRsqrt() = default; /** Initialize the function * * @param[in] compile_context The compile context to be used. @@ -44,10 +42,9 @@ public: * @param[out] dst Destination tensor info. Data types supported: same as @p src. */ void configure(const ClCompileContext &compile_context, const ITensorInfo *src, ITensorInfo *dst); - /** Static function to check if given info will lead to a valid configuration of @ref ClRsqrt + /** Static function to check if given info will lead to a valid configuration * - * @param[in] src First source tensor info. Data types supported: F16/F32. - * @param[in] dst Destination tensor info. Data types supported: same as @p src. + * Similar to @ref ClRsqrt::configure() * * @return a status */ @@ -58,8 +55,6 @@ public: class ClExp : public IClOperator { public: - /** Constructor */ - ClExp() = default; /** Initialize the function * * @param[in] compile_context The compile context to be used. @@ -67,10 +62,9 @@ public: * @param[out] dst Destination tensor info. Data types supported: same as @p src. */ void configure(const ClCompileContext &compile_context, const ITensorInfo *src, ITensorInfo *dst); - /** Static function to check if given info will lead to a valid configuration of @ref ClExp + /** Static function to check if given info will lead to a valid configuration * - * @param[in] src First source tensor info. Data types supported: F16/F32. - * @param[in] dst Destination tensor info. Data types supported: same as @p src. + * Similar to @ref ClExp::configure() * * @return a status */ @@ -81,8 +75,6 @@ public: class ClNeg : public IClOperator { public: - /** Constructor */ - ClNeg() = default; /** Initialize the function * * @param[in] compile_context The compile context to be used. @@ -90,10 +82,9 @@ public: * @param[out] dst Destination tensor info. Data types supported: same as @p src. */ void configure(const ClCompileContext &compile_context, const ITensorInfo *src, ITensorInfo *dst); - /** Static function to check if given info will lead to a valid configuration of @ref ClNeg + /** Static function to check if given info will lead to a valid configuration * - * @param[in] src First source tensor info. Data types supported: F16/F32. - * @param[in] dst Destination tensor info. Data types supported: same as @p src. + * Similar to @ref ClNeg::configure() * * @return a status */ @@ -104,8 +95,6 @@ public: class ClSin : public IClOperator { public: - /** Constructor */ - ClSin() = default; /** Initialize the function * * @param[in] compile_context The compile context to be used. @@ -113,10 +102,9 @@ public: * @param[out] dst Destination tensor info. Data types supported: same as @p src. */ void configure(const ClCompileContext &compile_context, const ITensorInfo *src, ITensorInfo *dst); - /** Static function to check if given info will lead to a valid configuration of @ref ClSin + /** Static function to check if given info will lead to a valid configuration * - * @param[in] src First source tensor info. Data types supported: F16/F32. - * @param[in] dst Destination tensor info. Data types supported: same as @p src. + * Similar to @ref ClSin::configure() * * @return a status */ @@ -127,8 +115,6 @@ public: class ClLog : public IClOperator { public: - /** Constructor */ - ClLog() = default; /** Initialize the function * * @param[in] compile_context The compile context to be used. @@ -136,10 +122,9 @@ public: * @param[out] dst Destination tensor info. Data types supported: same as @p src. */ void configure(const ClCompileContext &compile_context, const ITensorInfo *src, ITensorInfo *dst); - /** Static function to check if given info will lead to a valid configuration of @ref ClLog + /** Static function to check if given info will lead to a valid configuration * - * @param[in] src First source tensor info. Data types supported: F16/F32. - * @param[in] dst Destination tensor info. Data types supported: same as @p src. + * Similar to @ref ClLog::configure() * * @return a status */ @@ -157,10 +142,9 @@ public: * @param[out] dst Destination tensor info. Data types supported: same as @p src. */ void configure(const ClCompileContext &compile_context, const ITensorInfo *src, ITensorInfo *dst); - /** Static function to check if given info will lead to a valid configuration of @ref ClAbs + /** Static function to check if given info will lead to a valid configuration * - * @param[in] src First source tensor info. Data types supported: F16/F32. - * @param[in] dst Destination tensor info. Data types supported: same as @p src. + * Similar to @ref ClAbs::configure() * * @return a status */ @@ -178,10 +162,9 @@ public: * @param[out] dst Destination tensor info. Data types supported: same as @p src. */ void configure(const ClCompileContext &compile_context, const ITensorInfo *src, ITensorInfo *dst); - /** Static function to check if given info will lead to a valid configuration of @ref ClRound + /** Static function to check if given info will lead to a valid configuration * - * @param[in] src First source tensor info. Data types supported: F16/F32. - * @param[in] dst Destination tensor info. Data types supported: same as @p src. + * Similar to @ref ClRound::configure() * * @return a status */ diff --git a/src/runtime/gpu/cl/operators/ClFill.h b/src/runtime/gpu/cl/operators/ClFill.h index e632d88546..cc79b915a7 100644 --- a/src/runtime/gpu/cl/operators/ClFill.h +++ b/src/runtime/gpu/cl/operators/ClFill.h @@ -36,8 +36,6 @@ namespace opencl class ClFill : public IClOperator { public: - /** Constructor */ - ClFill() = default; /** Initialise the kernel's tensor and filling value * * @param[in] compile_context The compile context to be used. @@ -46,11 +44,9 @@ public: * @param[in] window Window to be used in case setting only part of a tensor. Default is nullptr. */ void configure(const CLCompileContext &compile_context, ITensorInfo *tensor, const PixelValue &constant_value, Window *window = nullptr); - /** Static function to check if given info will lead to a valid configuration of @ref kernels::ClFillKernel + /** Static function to check if given info will lead to a valid configuration * - * @param[in] tensor Source tensor info. Data types supported: All. - * @param[in] constant_value The value used to fill the planes of the tensor. - * @param[in] window Window to be used in case setting only part of a tensor. Default is nullptr. + * Similar to ClFill::configure() * * @return a status */ diff --git a/src/runtime/gpu/cl/operators/ClFlatten.h b/src/runtime/gpu/cl/operators/ClFlatten.h index 20ad06ee57..8bd619b518 100644 --- a/src/runtime/gpu/cl/operators/ClFlatten.h +++ b/src/runtime/gpu/cl/operators/ClFlatten.h @@ -35,8 +35,6 @@ namespace opencl class ClFlatten : public IClOperator { public: - /** Constructor */ - ClFlatten() = default; /** Configure operator for a given list of arguments * * Valid data layouts: diff --git a/src/runtime/gpu/cl/operators/ClFloor.h b/src/runtime/gpu/cl/operators/ClFloor.h index f54eef9140..90bdee6c7e 100644 --- a/src/runtime/gpu/cl/operators/ClFloor.h +++ b/src/runtime/gpu/cl/operators/ClFloor.h @@ -35,8 +35,6 @@ namespace opencl class ClFloor : public IClOperator { public: - /** Constructor */ - ClFloor() = default; /** Configure operator for a given list of arguments * * @param[in] compile_context The compile context to be used. @@ -44,10 +42,9 @@ public: * @param[in] dst Destination tensor info. Data type supported: same as @p src */ void configure(const ClCompileContext &compile_context, const ITensorInfo *src, ITensorInfo *dst); - /** Static function to check if given info will lead to a valid configuration of @ref ClFloor + /** Static function to check if given info will lead to a valid configuration * - * @param[in] src Source tensor info. Data types supported: F16/F32. - * @param[in] dst Destination tensor info. Data type supported: same as @p src + * Similar to ClFloor::configure() * * @return a status */ diff --git a/src/runtime/gpu/cl/operators/ClLogicalNot.h b/src/runtime/gpu/cl/operators/ClLogicalNot.h index 25ddf564b5..782ac0848f 100644 --- a/src/runtime/gpu/cl/operators/ClLogicalNot.h +++ b/src/runtime/gpu/cl/operators/ClLogicalNot.h @@ -35,8 +35,6 @@ namespace opencl class ClLogicalNot : public IClOperator { public: - /** Constructor */ - ClLogicalNot() = default; /** Configure operator for a given list of arguments * * @param[in] compile_context The compile context to be used. @@ -46,8 +44,7 @@ public: void configure(const CLCompileContext &compile_context, const ITensorInfo *src, ITensorInfo *dst); /** Static function to check if given info will lead to a valid configuration * - * @param[in] src Soure tensor info. Data types supported: U8. - * @param[in] dst Destination tensor info. Data types supported: same as @p src. + * Similar to ClLogicalNot::configure() * * @return a status */ diff --git a/src/runtime/gpu/cl/operators/ClMul.h b/src/runtime/gpu/cl/operators/ClMul.h index 4a662b3276..29d5885a1c 100644 --- a/src/runtime/gpu/cl/operators/ClMul.h +++ b/src/runtime/gpu/cl/operators/ClMul.h @@ -35,8 +35,6 @@ namespace opencl class ClMul : public IClOperator { public: - /** Default Constructor */ - ClMul() = default; /** Initialise the kernel's sources, dst and convertion policy. * * Valid configurations (src1,src2) -> Output : @@ -81,8 +79,6 @@ public: class ClComplexMul : public IClOperator { public: - /** Default Constructor */ - ClComplexMul() = default; /** Initialise the kernel's sources, dst. * * @param[in] compile_context The compile context to be used. diff --git a/src/runtime/gpu/cl/operators/ClPRelu.h b/src/runtime/gpu/cl/operators/ClPRelu.h index 70202aeb81..3a02030635 100644 --- a/src/runtime/gpu/cl/operators/ClPRelu.h +++ b/src/runtime/gpu/cl/operators/ClPRelu.h @@ -38,8 +38,6 @@ namespace opencl class ClPRelu : public IClOperator { public: - /** Default constructor */ - ClPRelu() = default; /** Set the input and output tensor. * * @note If the output tensor is a nullptr or is equal to the input, the activation function will be performed in-place @@ -50,11 +48,9 @@ public: * @param[out] output Destination tensor. Data type supported: same as @p input */ void configure(const CLCompileContext &compile_context, ITensorInfo *input, ITensorInfo *alpha, ITensorInfo *output); - /** Static function to check if given info will lead to a valid configuration of @ref arm_compute::opencl::kernels::ClArithmeticKernel for PRELU + /** Static function to check if given info will lead to a valid configuration * - * @param[in] input Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32. - * @param[in] alpha PRelu layer parameters. Data types supported: same of @p input. - * @param[in] output Destination tensor info. Data type supported: same as @p input + * Similar to ClPRelu::configure() * * @return a status */ diff --git a/src/runtime/gpu/cl/operators/ClPermute.h b/src/runtime/gpu/cl/operators/ClPermute.h index 20e7a32428..867aba010d 100644 --- a/src/runtime/gpu/cl/operators/ClPermute.h +++ b/src/runtime/gpu/cl/operators/ClPermute.h @@ -35,8 +35,6 @@ namespace opencl class ClPermute : public IClOperator { public: - /** Constructor */ - ClPermute() = default; /** Initialise the kernel's inputs and outputs and permute vector * * @note Arbitrary permutation vectors are supported with rank not greater than 4 @@ -47,13 +45,9 @@ public: * @param[in] perm Permutation vector */ void configure(const CLCompileContext &compile_context, const ITensorInfo *src, ITensorInfo *dst, const PermutationVector &perm); - /** Static function to check if given info will lead to a valid configuration of @ref kernels::ClPermuteKernel. + /** Static function to check if given info will lead to a valid configuration * - * @note Arbitrary permutation vectors are supported with rank not greater than 4 - * - * @param[in] src First tensor src info. Data types supported: All. - * @param[in] dst Output tensor info. Data types supported: same as @p src. - * @param[in] perm Permutation vector + * Similar to ClPermute::configure() * * @return a status */ diff --git a/src/runtime/gpu/cl/operators/ClQuantize.h b/src/runtime/gpu/cl/operators/ClQuantize.h index 0b6d2c8cbe..b15d389cca 100644 --- a/src/runtime/gpu/cl/operators/ClQuantize.h +++ b/src/runtime/gpu/cl/operators/ClQuantize.h @@ -35,8 +35,6 @@ namespace opencl class ClQuantize : public IClOperator { public: - /** Constructor */ - ClQuantize() = default; /** Set the input and output tensors. * * @param[in] compile_context The compile context to be used. diff --git a/src/runtime/gpu/cl/operators/ClReshape.h b/src/runtime/gpu/cl/operators/ClReshape.h index 8cccc5776c..b3d9267be4 100644 --- a/src/runtime/gpu/cl/operators/ClReshape.h +++ b/src/runtime/gpu/cl/operators/ClReshape.h @@ -35,8 +35,6 @@ namespace opencl class ClReshape : public IClOperator { public: - /** Constructor */ - ClReshape() = default; /** Initialise the kernel's inputs and outputs * * @param[in] compile_context The compile context to be used. @@ -44,11 +42,9 @@ public: * @param[out] output Output info. Data type supported: Same as @p input */ void configure(const CLCompileContext &compile_context, const ITensorInfo *input, ITensorInfo *output); - - /** Static function to check if given info will lead to a valid configuration of @ref kernels::ClReshapeKernel + /** Static function to check if given info will lead to a valid configuration * - * @param[in] input Input tensor info. Data type supported: All - * @param[in] output Output tensor info. Data type supported: Same as @p input + * Similar to ClReshape::configure() * * @return a status */ diff --git a/src/runtime/gpu/cl/operators/ClScale.h b/src/runtime/gpu/cl/operators/ClScale.h index 6eccb59be8..905c43a41c 100644 --- a/src/runtime/gpu/cl/operators/ClScale.h +++ b/src/runtime/gpu/cl/operators/ClScale.h @@ -51,13 +51,9 @@ public: * @param[in] info @ref ScaleKernelInfo descriptor to be used to configure */ void configure(const CLCompileContext &compile_context, ITensorInfo *src, ITensorInfo *dst, const ScaleKernelInfo &info); - - /** Static function to check if given info will lead to a valid configuration of @ref ClScale + /** Static function to check if given info will lead to a valid configuration * - * @param[in] src Source tensor info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/F16/F32. - * @param[in] dst Output tensor info. Data type supported: Same as @p src - * All but the lowest two dimensions must be the same size as in the input tensor, i.e. scaling is only performed within the XY-plane. - * @param[in] info @ref ScaleKernelInfo descriptor to be used to validate + * Similar to ClScale::configure() * * @return a status */ @@ -71,4 +67,4 @@ protected: }; } // namespace opencl } // namespace arm_compute -#endif /*ARM_COMPUTE_CLSCALE_H */ +#endif /* ARM_COMPUTE_CLSCALE_H */ diff --git a/src/runtime/gpu/cl/operators/ClSoftmax.h b/src/runtime/gpu/cl/operators/ClSoftmax.h index f19a51fc5e..c85b193d9d 100644 --- a/src/runtime/gpu/cl/operators/ClSoftmax.h +++ b/src/runtime/gpu/cl/operators/ClSoftmax.h @@ -51,15 +51,13 @@ public: * @param[in] src Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32 for Softmax and F16/F32 for Log Softmax * @param[out] dst Destination tensor info. Data types supported: same as @p src * @param[in] info Contains information consumed by kernels for softmax described in @ref SoftmaxKernelInfo. - * */ void configure(const CLCompileContext &compile_context, const ITensorInfo &src, ITensorInfo &dst, const SoftmaxKernelInfo &info); - /** Static function to check if the given info will lead to a valid configuration + /** Static function to check if given info will lead to a valid configuration * - * @param[in] src Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32 for Softmax and F16/F32 for Log Softmax - * @param[out] dst Destination tensor info. Data types supported: same as @p src - * @param[in] info Contains information consumed by kernels for softmax described in @ref SoftmaxKernelInfo. + * Similar to ClSoftmax::configure() * + * @return a status */ static Status validate(const ITensorInfo &src, const ITensorInfo &dst, const SoftmaxKernelInfo &info); // Inherited methods overridden: diff --git a/src/runtime/gpu/cl/operators/ClSub.h b/src/runtime/gpu/cl/operators/ClSub.h index bcad84d583..2dac11c00e 100644 --- a/src/runtime/gpu/cl/operators/ClSub.h +++ b/src/runtime/gpu/cl/operators/ClSub.h @@ -39,8 +39,6 @@ namespace opencl class ClSub : public IClOperator { public: - /** Default Constructor */ - ClSub() = default; /** Configure function for a given list of arguments. * * Valid configurations (src1,src2) -> dst : @@ -68,27 +66,9 @@ public: */ void configure(const ClCompileContext &compile_context, ITensorInfo *src1, ITensorInfo *src2, ITensorInfo *dst, ConvertPolicy policy, const ActivationLayerInfo &act_info = ActivationLayerInfo()); - /** Static function to check if given info will lead to a valid configuration of @ref ClSub + /** Static function to check if given info will lead to a valid configuration * - * Valid configurations (src1,src2) -> dst : - * - * - (U8,U8) -> U8 - * - (U8,U8) -> S16 - * - (S16,U8) -> S16 - * - (U8,S16) -> S16 - * - (S16,S16) -> S16 - * - (S32,S32) -> S32 - * - (F16,F16) -> F16 - * - (F32,F32) -> F32 - * - (QASYMM8,QASYMM8) -> QASYMM8 - * - (QASYMM8_SIGNED,QASYMM8_SIGNED) -> QASYMM8_SIGNED - * - (QSYMM16,QSYMM16) -> QSYMM16 - * - * @param[in] src1 First source tensor info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/S32/F16/F32. - * @param[in] src2 Second source tensor info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/S32/F16/F32. - * @param[in] dst Destination tensor info. Data types supported: U8/QASYMM8/QASYMM8_SIGNED/S16/QSYMM16/S32/F16/F32. - * @param[in] policy Policy to use to handle overflow. - * @param[in] act_info (Optional) Activation layer information in case of a fused activation. + * Similar to @ref ClSub::configure() * * @return a status */ diff --git a/src/runtime/gpu/cl/operators/ClTranspose.h b/src/runtime/gpu/cl/operators/ClTranspose.h index d898f677ca..dcd80820bb 100644 --- a/src/runtime/gpu/cl/operators/ClTranspose.h +++ b/src/runtime/gpu/cl/operators/ClTranspose.h @@ -35,8 +35,6 @@ namespace opencl class ClTranspose : public IClOperator { public: - /** Constructor */ - ClTranspose() = default; /** Initialise the kernel's inputs and outputs * * @param[in] compile_context The compile context to be used. @@ -44,10 +42,9 @@ public: * @param[in] dst The dst tensor info. Data types supported: Same as @p src */ void configure(const CLCompileContext &compile_context, const ITensorInfo *src, ITensorInfo *dst); - /** Static function to check if given info will lead to a valid configuration of @ref kernels::ClTransposeKernel. + /** Static function to check if given info will lead to a valid configuration * - * @param[in] src First tensor src info. Data types supported: All. - * @param[in] dst Output tensor info. Data types supported: same as @p src. + * Similar to ClTranspose::configure() * * @return a status */ -- cgit v1.2.1