commit 2eb5d16b839cbc28c6cb7f0de7a0bf15290b425a
author Georgios Pinitas <georgios.pinitas@arm.com> Fri Jul 02 09:01:49 2021 +0100
committer Georgios Pinitas <georgios.pinitas@arm.com> Fri Jul 02 15:47:11 2021 +0000
tree 523d495c3a4c07d87b337c45a81afa06c9b1f495
parent 4dfc5538948c196def6d2e3305fe8051a5df3f15

Align kernel/operator header layout

- Redirect validate documentation to configure
- Align header names
- Align class layout

Signed-off-by: Georgios Pinitas <georgios.pinitas@arm.com>
Change-Id: Ia40f67383826a66e9f9a33745d66805551e31a3a
Reviewed-on: https://review.mlplatform.org/c/ml/ComputeLibrary/+/5897
Comments-Addressed: Arm Jenkins <bsgcomp@arm.com>
Tested-by: Arm Jenkins <bsgcomp@arm.com>
Reviewed-by: Michele Di Giorgio <michele.digiorgio@arm.com>

src/runtime/gpu/cl/operators/ClCrop.h

diff --git a/src/runtime/gpu/cl/operators/ClCrop.h b/src/runtime/gpu/cl/operators/ClCrop.h
index acfbf14..cca69d6 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 @@
 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 @@
      */
     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 */