Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2017 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/core/CL/kernels/CLMinMaxLocationKernel.h" |
| 28 | #include "arm_compute/runtime/CL/CLArray.h" |
| 29 | #include "arm_compute/runtime/IFunction.h" |
| 30 | |
| 31 | namespace arm_compute |
| 32 | { |
| 33 | class ICLTensor; |
| 34 | using ICLImage = ICLTensor; |
| 35 | |
| 36 | /** Basic function to execute min and max location. This function calls the following OpenCL kernels: |
| 37 | * |
| 38 | * -# @ref CLMinMaxKernel |
| 39 | * -# @ref CLMinMaxLocationKernel |
| 40 | */ |
| 41 | class CLMinMaxLocation : public IFunction |
| 42 | { |
| 43 | public: |
| 44 | /** Constructor */ |
| 45 | CLMinMaxLocation(); |
| 46 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 47 | CLMinMaxLocation(const CLMinMaxLocation &) = delete; |
| 48 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 49 | CLMinMaxLocation &operator=(const CLMinMaxLocation &) = delete; |
| 50 | /** Allow instances of this class to be moved */ |
| 51 | CLMinMaxLocation(CLMinMaxLocation &&) = default; |
| 52 | /** Allow instances of this class to be moved */ |
| 53 | CLMinMaxLocation &operator=(CLMinMaxLocation &&) = default; |
| 54 | /** Initialise the kernel's inputs and outputs. |
| 55 | * |
| 56 | * @note When locations of min and max occurrences are requested, the reported number of locations is limited to the given array size. |
| 57 | * |
Michele Di Giorgio | ef4b4ae | 2017-07-04 17:19:43 +0100 | [diff] [blame] | 58 | * @param[in] input Input image. Data types supported: U8/S16/F32. |
| 59 | * @param[out] min Minimum value of image. Data types supported: S32 if input type is U8/S16, F32 if input type is F32. |
| 60 | * @param[out] max Maximum value of image. Data types supported: S32 if input type is U8/S16, F32 if input type is F32. |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 61 | * @param[out] min_loc (Optional) Array of Coordinates2D used to store minimum value locations. |
| 62 | * @param[out] max_loc (Optional) Array of Coordinates2D used to store maximum value locations. |
| 63 | * @param[out] min_count (Optional) Number of minimum value encounters. |
| 64 | * @param[out] max_count (Optional) Number of maximum value encounters. |
| 65 | */ |
Michele Di Giorgio | ef4b4ae | 2017-07-04 17:19:43 +0100 | [diff] [blame] | 66 | void configure(const ICLImage *input, void *min, void *max, |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 67 | CLCoordinates2DArray *min_loc = nullptr, CLCoordinates2DArray *max_loc = nullptr, |
| 68 | uint32_t *min_count = nullptr, uint32_t *max_count = nullptr); |
| 69 | |
| 70 | // Inherited methods overridden: |
| 71 | void run() override; |
| 72 | |
| 73 | private: |
| 74 | CLMinMaxKernel _min_max_kernel; /**< Kernel that performs min/max */ |
| 75 | CLMinMaxLocationKernel _min_max_loc_kernel; /**< Kernel that counts min/max occurrences and identifies their positions */ |
| 76 | cl::Buffer _min_max_vals; /**< Buffer to collect min, max values */ |
| 77 | cl::Buffer _min_max_count_vals; /**< Buffer to collect min, max values */ |
Michele Di Giorgio | ef4b4ae | 2017-07-04 17:19:43 +0100 | [diff] [blame] | 78 | void *_min; /**< Minimum value. */ |
| 79 | void *_max; /**< Maximum value. */ |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 80 | uint32_t *_min_count; /**< Minimum value occurrences. */ |
| 81 | uint32_t *_max_count; /**< Maximum value occurrences. */ |
| 82 | CLCoordinates2DArray *_min_loc; /**< Minimum value occurrences coordinates. */ |
| 83 | CLCoordinates2DArray *_max_loc; /**< Maximum value occurrences coordinates. */ |
| 84 | }; |
| 85 | } |
| 86 | #endif /*__ARM_COMPUTE_CLMINMAXLOCATION_H__ */ |