diff options
author | Alex Gilday <alexander.gilday@arm.com> | 2018-03-21 13:54:09 +0000 |
---|---|---|
committer | Anthony Barbier <anthony.barbier@arm.com> | 2018-11-02 16:49:16 +0000 |
commit | c357c47be8a3f210f9eee9a05cc13f1051b036d3 (patch) | |
tree | a88ac857150da970a0862a3479b78c616d8aa1d3 /arm_compute/core/GLES_COMPUTE | |
parent | 724079d6fce3bf6a05cd6c7b4884b132b27e9e90 (diff) | |
download | ComputeLibrary-c357c47be8a3f210f9eee9a05cc13f1051b036d3.tar.gz |
COMPMID-1008: Fix Doxygen issues
Change-Id: Ie73d8771f85d1f5b059f3a56f1bbd73c98e94a38
Reviewed-on: https://eu-gerrit-1.euhpc.arm.com/124723
Reviewed-by: Michalis Spyrou <michalis.spyrou@arm.com>
Tested-by: Jenkins <bsgcomp@arm.com>
Diffstat (limited to 'arm_compute/core/GLES_COMPUTE')
11 files changed, 61 insertions, 31 deletions
diff --git a/arm_compute/core/GLES_COMPUTE/GCKernelLibrary.h b/arm_compute/core/GLES_COMPUTE/GCKernelLibrary.h index 34bd5673b8..c0d64e2edb 100644 --- a/arm_compute/core/GLES_COMPUTE/GCKernelLibrary.h +++ b/arm_compute/core/GLES_COMPUTE/GCKernelLibrary.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2017 ARM Limited. + * Copyright (c) 2017-2018 ARM Limited. * * SPDX-License-Identifier: MIT * @@ -51,9 +51,9 @@ public: GCProgram(const GCProgram &) = default; /** Default Move Constructor. */ GCProgram(GCProgram &&) = default; - /** Default copy assignment operator. */ + /** Default copy assignment operator */ GCProgram &operator=(const GCProgram &) = default; - /** Default move assignment operator. */ + /** Default move assignment operator */ GCProgram &operator=(GCProgram &&) = default; /** Returns program name. * @@ -93,9 +93,9 @@ public: GCKernel(const GCKernel &) = default; /** Default Move Constructor. */ GCKernel(GCKernel &&) = default; - /** Default copy assignment operator. */ + /** Default copy assignment operator */ GCKernel &operator=(const GCKernel &) = default; - /** Default move assignment operator. */ + /** Default move assignment operator */ GCKernel &operator=(GCKernel &&) = default; /** Constructor. * @@ -194,11 +194,14 @@ private: ~GCKernelLibrary(); public: - /** Prevent instances of this class from being copied. */ + /** Prevent instances of this class from being copied */ GCKernelLibrary(const GCKernelLibrary &) = delete; - /** Prevent instances of this class from being copied. */ + /** Prevent instances of this class from being copied */ const GCKernelLibrary &operator=(const GCKernelLibrary &) = delete; - + /** Get the static instance of @ref GCKernelLibrary. + * + * @return The static instance of GCKernelLibrary. + */ static GCKernelLibrary &get(); /** Initialises the kernel library. * diff --git a/arm_compute/core/GLES_COMPUTE/IGCSimpleKernel.h b/arm_compute/core/GLES_COMPUTE/IGCSimpleKernel.h index a23c4e774e..b3d841d2fc 100644 --- a/arm_compute/core/GLES_COMPUTE/IGCSimpleKernel.h +++ b/arm_compute/core/GLES_COMPUTE/IGCSimpleKernel.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2016, 2017 ARM Limited. + * Copyright (c) 2016-2018 ARM Limited. * * SPDX-License-Identifier: MIT * @@ -36,13 +36,13 @@ class IGCSimpleKernel : public IGCKernel public: /** Constructor. */ IGCSimpleKernel(); - /** Prevent instances of this class from being copied (As this class contains pointers). */ + /** Prevent instances of this class from being copied (As this class contains pointers) */ IGCSimpleKernel(const IGCSimpleKernel &) = delete; - /** Prevent instances of this class from being copied (As this class contains pointers). */ + /** Prevent instances of this class from being copied (As this class contains pointers) */ IGCSimpleKernel &operator=(const IGCSimpleKernel &) = delete; - /** Allow instances of this class to be moved. */ + /** Allow instances of this class to be moved */ IGCSimpleKernel(IGCSimpleKernel &&) = default; - /** Allow instances of this class to be moved. */ + /** Allow instances of this class to be moved */ IGCSimpleKernel &operator=(IGCSimpleKernel &&) = default; /** Default destructor */ ~IGCSimpleKernel() = default; diff --git a/arm_compute/core/GLES_COMPUTE/IGCTensor.h b/arm_compute/core/GLES_COMPUTE/IGCTensor.h index 7329864b85..fcfcf690a9 100644 --- a/arm_compute/core/GLES_COMPUTE/IGCTensor.h +++ b/arm_compute/core/GLES_COMPUTE/IGCTensor.h @@ -38,10 +38,10 @@ public: /** Default constructor. */ IGCTensor(); - /** Prevent instances of this class from being copied (As this class contains pointers). */ + /** Prevent instances of this class from being copied (As this class contains pointers) */ IGCTensor(const IGCTensor &) = delete; - /** Prevent instances of this class from being copy assigned (As this class contains pointers). */ + /** Prevent instances of this class from being copy assigned (As this class contains pointers) */ IGCTensor &operator=(const IGCTensor &) = delete; /** Allow instances of this class to be moved */ @@ -107,6 +107,7 @@ private: bool _needs_shifting; }; +/** Interface for GLES Compute image */ using IGCImage = IGCTensor; } #endif /*__ARM_COMPUTE_IGCTENSOR_H__ */ diff --git a/arm_compute/core/GLES_COMPUTE/kernels/GCAbsoluteDifferenceKernel.h b/arm_compute/core/GLES_COMPUTE/kernels/GCAbsoluteDifferenceKernel.h index 71f7b37700..a441d24353 100644 --- a/arm_compute/core/GLES_COMPUTE/kernels/GCAbsoluteDifferenceKernel.h +++ b/arm_compute/core/GLES_COMPUTE/kernels/GCAbsoluteDifferenceKernel.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2017 ARM Limited. + * Copyright (c) 2017-2018 ARM Limited. * * SPDX-License-Identifier: MIT * @@ -40,13 +40,13 @@ class GCAbsoluteDifferenceKernel : public IGCKernel public: /** Default constructor. */ GCAbsoluteDifferenceKernel(); - /** Prevent instances of this class from being copied (As this class contains pointers). */ + /** Prevent instances of this class from being copied (As this class contains pointers) */ GCAbsoluteDifferenceKernel(const GCAbsoluteDifferenceKernel &) = delete; - /** Prevent instances of this class from being copied (As this class contains pointers). */ + /** Prevent instances of this class from being copied (As this class contains pointers) */ GCAbsoluteDifferenceKernel &operator=(const GCAbsoluteDifferenceKernel &) = delete; - /** Allow instances of this class to be moved. */ + /** Allow instances of this class to be moved */ GCAbsoluteDifferenceKernel(GCAbsoluteDifferenceKernel &&) = default; - /** Allow instances of this class to be moved. */ + /** Allow instances of this class to be moved */ GCAbsoluteDifferenceKernel &operator=(GCAbsoluteDifferenceKernel &&) = default; /** Default destructor */ ~GCAbsoluteDifferenceKernel() = default; diff --git a/arm_compute/core/GLES_COMPUTE/kernels/GCBatchNormalizationLayerKernel.h b/arm_compute/core/GLES_COMPUTE/kernels/GCBatchNormalizationLayerKernel.h index 15d7f79afb..754268a348 100644 --- a/arm_compute/core/GLES_COMPUTE/kernels/GCBatchNormalizationLayerKernel.h +++ b/arm_compute/core/GLES_COMPUTE/kernels/GCBatchNormalizationLayerKernel.h @@ -43,7 +43,7 @@ public: GCBatchNormalizationLayerKernel &operator=(const GCBatchNormalizationLayerKernel &) = delete; /** Default Move Constructor. */ GCBatchNormalizationLayerKernel(GCBatchNormalizationLayerKernel &&) = default; - /** Default move assignment operator. */ + /** Default move assignment operator */ GCBatchNormalizationLayerKernel &operator=(GCBatchNormalizationLayerKernel &&) = default; /** Default destructor */ ~GCBatchNormalizationLayerKernel() = default; diff --git a/arm_compute/core/GLES_COMPUTE/kernels/GCDepthwiseConvolutionLayer3x3Kernel.h b/arm_compute/core/GLES_COMPUTE/kernels/GCDepthwiseConvolutionLayer3x3Kernel.h index e10769db5e..46b9e897bb 100644 --- a/arm_compute/core/GLES_COMPUTE/kernels/GCDepthwiseConvolutionLayer3x3Kernel.h +++ b/arm_compute/core/GLES_COMPUTE/kernels/GCDepthwiseConvolutionLayer3x3Kernel.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2017 ARM Limited. + * Copyright (c) 2017-2018 ARM Limited. * * SPDX-License-Identifier: MIT * @@ -43,7 +43,7 @@ public: GCDepthwiseConvolutionLayer3x3Kernel &operator=(const GCDepthwiseConvolutionLayer3x3Kernel &) = delete; /** Default Move Constructor. */ GCDepthwiseConvolutionLayer3x3Kernel(GCDepthwiseConvolutionLayer3x3Kernel &&) = default; - /** Default move assignment operator. */ + /** Default move assignment operator */ GCDepthwiseConvolutionLayer3x3Kernel &operator=(GCDepthwiseConvolutionLayer3x3Kernel &&) = default; /** Initialize the function's source, destination, conv and border_size. * diff --git a/arm_compute/core/GLES_COMPUTE/kernels/GCDirectConvolutionLayerKernel.h b/arm_compute/core/GLES_COMPUTE/kernels/GCDirectConvolutionLayerKernel.h index 415b781bc6..f1c9c1933d 100644 --- a/arm_compute/core/GLES_COMPUTE/kernels/GCDirectConvolutionLayerKernel.h +++ b/arm_compute/core/GLES_COMPUTE/kernels/GCDirectConvolutionLayerKernel.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2017 ARM Limited. + * Copyright (c) 2017-2018 ARM Limited. * * SPDX-License-Identifier: MIT * @@ -80,8 +80,11 @@ private: gles::NDRange _lws; }; +/** Interface for the 1x1 direct convolution kernel */ using GCDirectConvolutionLayer1x1Kernel = GCDirectConvolutionLayerKernel<1>; +/** Interface for the 3x3 direct convolution kernel */ using GCDirectConvolutionLayer3x3Kernel = GCDirectConvolutionLayerKernel<3>; +/** Interface for the 5x5 direct convolution kernel */ using GCDirectConvolutionLayer5x5Kernel = GCDirectConvolutionLayerKernel<5>; } #endif /*__ARM_COMPUTE_GCDIRECTCONVOLUTIONLAYERKERNEL_H__ */ diff --git a/arm_compute/core/GLES_COMPUTE/kernels/GCNormalizationLayerKernel.h b/arm_compute/core/GLES_COMPUTE/kernels/GCNormalizationLayerKernel.h index e8bc7ad2b2..96a04d1651 100644 --- a/arm_compute/core/GLES_COMPUTE/kernels/GCNormalizationLayerKernel.h +++ b/arm_compute/core/GLES_COMPUTE/kernels/GCNormalizationLayerKernel.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2017 ARM Limited. + * Copyright (c) 2017-2018 ARM Limited. * * SPDX-License-Identifier: MIT * @@ -43,7 +43,7 @@ public: GCNormalizationLayerKernel &operator=(const GCNormalizationLayerKernel &) = delete; /** Default Move Constructor. */ GCNormalizationLayerKernel(GCNormalizationLayerKernel &&) = default; - /** Default move assignment operator. */ + /** Default move assignment operator */ GCNormalizationLayerKernel &operator=(GCNormalizationLayerKernel &&) = default; /** Default destrutor */ ~GCNormalizationLayerKernel() = default; diff --git a/arm_compute/core/GLES_COMPUTE/kernels/GCNormalizePlanarYUVLayerKernel.h b/arm_compute/core/GLES_COMPUTE/kernels/GCNormalizePlanarYUVLayerKernel.h index ecf5f44f71..0d785ca0d4 100644 --- a/arm_compute/core/GLES_COMPUTE/kernels/GCNormalizePlanarYUVLayerKernel.h +++ b/arm_compute/core/GLES_COMPUTE/kernels/GCNormalizePlanarYUVLayerKernel.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2017 ARM Limited. + * Copyright (c) 2017-2018 ARM Limited. * * SPDX-License-Identifier: MIT * @@ -43,7 +43,7 @@ public: GCNormalizePlanarYUVLayerKernel &operator=(const GCNormalizePlanarYUVLayerKernel &) = delete; /** Default Move Constructor. */ GCNormalizePlanarYUVLayerKernel(GCNormalizePlanarYUVLayerKernel &&) = default; - /** Default move assignment operator. */ + /** Default move assignment operator */ GCNormalizePlanarYUVLayerKernel &operator=(GCNormalizePlanarYUVLayerKernel &&) = default; /** Default destructor */ ~GCNormalizePlanarYUVLayerKernel() = default; diff --git a/arm_compute/core/GLES_COMPUTE/kernels/GCPixelWiseMultiplicationKernel.h b/arm_compute/core/GLES_COMPUTE/kernels/GCPixelWiseMultiplicationKernel.h index 3b01b4ad4d..3fb24825a4 100644 --- a/arm_compute/core/GLES_COMPUTE/kernels/GCPixelWiseMultiplicationKernel.h +++ b/arm_compute/core/GLES_COMPUTE/kernels/GCPixelWiseMultiplicationKernel.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2017 ARM Limited. + * Copyright (c) 2017-2018 ARM Limited. * * SPDX-License-Identifier: MIT * @@ -39,9 +39,9 @@ class GCPixelWiseMultiplicationKernel : public IGCKernel public: /** Default constructor.*/ GCPixelWiseMultiplicationKernel(); - /** Prevent instances of this class from being copied (As this class contains pointers). */ + /** Prevent instances of this class from being copied (As this class contains pointers) */ GCPixelWiseMultiplicationKernel(const GCPixelWiseMultiplicationKernel &) = delete; - /** Prevent instances of this class from being copied (As this class contains pointers). */ + /** Prevent instances of this class from being copied (As this class contains pointers) */ GCPixelWiseMultiplicationKernel &operator=(const GCPixelWiseMultiplicationKernel &) = delete; /** Allow instances of this class to be moved */ GCPixelWiseMultiplicationKernel(GCPixelWiseMultiplicationKernel &&) = default; diff --git a/arm_compute/core/GLES_COMPUTE/kernels/GCWeightsReshapeKernel.h b/arm_compute/core/GLES_COMPUTE/kernels/GCWeightsReshapeKernel.h index bf315a2f15..bf535229ff 100644 --- a/arm_compute/core/GLES_COMPUTE/kernels/GCWeightsReshapeKernel.h +++ b/arm_compute/core/GLES_COMPUTE/kernels/GCWeightsReshapeKernel.h @@ -28,6 +28,29 @@ namespace arm_compute { +/** GLES Compute kernel to perform reshaping on the weights used by convolution and locally connected layer + * + * Rearranges each 3-dimensional kernel to a single row leading to a matrix with linearized kernels. + * In combination with the @ref GCIm2ColKernel can transform a convolution to a matrix multiplication. + * + * For example assuming a 3D weight kernel of 3x3 dimensions and depth of 2 we have: + * @f[ + * \left( \begin{array}{ccc} + * a000 & a001 & a002 \\ + * a010 & a011 & a012 \\ + * a020 & a021 & a022 \\ + * \end{array} \right) + * \left( \begin{array}{ccc} + * a100 & a101 & a102 \\ + * a110 & a111 & a112 \\ + * a120 & a121 & a122 \\ + * \end{array} \right) + * \rightarrow + * \left( \begin{array}{ccccccccc} + * a000 & a001 & a002 & a010 & a011 & a012 & a020 & a021 & a022 & a100 & a101 & a102 & a110 & a111 & a112 & a120 & a121 & a122 \\ + * \end{array} \right) + * @f] + */ class GCWeightsReshapeKernel : public IGCKernel { public: |