1 /* 2 * Copyright (c) 2017-2020 Arm Limited. 3 * 4 * SPDX-License-Identifier: MIT 5 * 6 * Permission is hereby granted, free of charge, to any person obtaining a copy 7 * of this software and associated documentation files (the "Software"), to 8 * deal in the Software without restriction, including without limitation the 9 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 10 * sell copies of the Software, and to permit persons to whom the Software is 11 * furnished to do so, subject to the following conditions: 12 * 13 * The above copyright notice and this permission notice shall be included in all 14 * copies or substantial portions of the Software. 15 * 16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 22 * SOFTWARE. 23 */ 24 #ifndef ARM_COMPUTE_CLMINMAXLOCATION_H 25 #define ARM_COMPUTE_CLMINMAXLOCATION_H 26 27 #include "arm_compute/runtime/CL/CLArray.h" 28 #include "arm_compute/runtime/IFunction.h" 29 30 #include <memory> 31 32 namespace arm_compute 33 { 34 class CLCompileContext; 35 class CLMinMaxKernel; 36 class CLMinMaxLocationKernel; 37 class ICLTensor; 38 using ICLImage = ICLTensor; 39 40 /** Basic function to execute min and max location. This function calls the following OpenCL kernels: 41 * 42 * -# @ref CLMinMaxKernel 43 * -# @ref CLMinMaxLocationKernel 44 * 45 * @deprecated This function is deprecated and is intended to be removed in 21.05 release 46 * 47 */ 48 class CLMinMaxLocation : public IFunction 49 { 50 public: 51 /** Constructor */ 52 CLMinMaxLocation(); 53 /** Prevent instances of this class from being copied (As this class contains pointers) */ 54 CLMinMaxLocation(const CLMinMaxLocation &) = delete; 55 /** Prevent instances of this class from being copied (As this class contains pointers) */ 56 CLMinMaxLocation &operator=(const CLMinMaxLocation &) = delete; 57 /** Allow instances of this class to be moved */ 58 CLMinMaxLocation(CLMinMaxLocation &&) = default; 59 /** Allow instances of this class to be moved */ 60 CLMinMaxLocation &operator=(CLMinMaxLocation &&) = default; 61 /** Default destructor */ 62 ~CLMinMaxLocation(); 63 /** Initialise the kernel's inputs and outputs. 64 * 65 * @note When locations of min and max occurrences are requested, the reported number of locations is limited to the given array size. 66 * 67 * @param[in] input Input image. Data types supported: U8/S16/F32. 68 * @param[out] min Minimum value of image. Data types supported: S32 if input type is U8/S16, F32 if input type is F32. 69 * @param[out] max Maximum value of image. Data types supported: S32 if input type is U8/S16, F32 if input type is F32. 70 * @param[out] min_loc (Optional) Array of Coordinates2D used to store minimum value locations. 71 * @param[out] max_loc (Optional) Array of Coordinates2D used to store maximum value locations. 72 * @param[out] min_count (Optional) Number of minimum value encounters. 73 * @param[out] max_count (Optional) Number of maximum value encounters. 74 */ 75 void configure(const ICLImage *input, void *min, void *max, 76 CLCoordinates2DArray *min_loc = nullptr, CLCoordinates2DArray *max_loc = nullptr, 77 uint32_t *min_count = nullptr, uint32_t *max_count = nullptr); 78 /** Initialise the kernel's inputs and outputs. 79 * 80 * @note When locations of min and max occurrences are requested, the reported number of locations is limited to the given array size. 81 * 82 * @param[in] compile_context The compile context to be used. 83 * @param[in] input Input image. Data types supported: U8/S16/F32. 84 * @param[out] min Minimum value of image. Data types supported: S32 if input type is U8/S16, F32 if input type is F32. 85 * @param[out] max Maximum value of image. Data types supported: S32 if input type is U8/S16, F32 if input type is F32. 86 * @param[out] min_loc (Optional) Array of Coordinates2D used to store minimum value locations. 87 * @param[out] max_loc (Optional) Array of Coordinates2D used to store maximum value locations. 88 * @param[out] min_count (Optional) Number of minimum value encounters. 89 * @param[out] max_count (Optional) Number of maximum value encounters. 90 */ 91 void configure(const CLCompileContext &compile_context, const ICLImage *input, void *min, void *max, 92 CLCoordinates2DArray *min_loc = nullptr, CLCoordinates2DArray *max_loc = nullptr, 93 uint32_t *min_count = nullptr, uint32_t *max_count = nullptr); 94 95 // Inherited methods overridden: 96 void run() override; 97 98 private: 99 std::unique_ptr<CLMinMaxKernel> _min_max_kernel; /**< Kernel that performs min/max */ 100 std::unique_ptr<CLMinMaxLocationKernel> _min_max_loc_kernel; /**< Kernel that counts min/max occurrences and identifies their positions */ 101 cl::Buffer _min_max_vals; /**< Buffer to collect min, max values */ 102 cl::Buffer _min_max_count_vals; /**< Buffer to collect min, max values */ 103 void *_min; /**< Minimum value. */ 104 void *_max; /**< Maximum value. */ 105 uint32_t *_min_count; /**< Minimum value occurrences. */ 106 uint32_t *_max_count; /**< Maximum value occurrences. */ 107 CLCoordinates2DArray *_min_loc; /**< Minimum value occurrences coordinates. */ 108 CLCoordinates2DArray *_max_loc; /**< Maximum value occurrences coordinates. */ 109 }; 110 } 111 #endif /*ARM_COMPUTE_CLMINMAXLOCATION_H */ 112