Compute Library
 21.02
NEMinMaxLocation.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-2021 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_NEMINMAXLOCATION_H
25 #define ARM_COMPUTE_NEMINMAXLOCATION_H
26 
30 
31 #include <cstdint>
32 #include <memory>
33 
34 namespace arm_compute
35 {
36 class ITensor;
37 class NEMinMaxKernel;
38 class NEMinMaxLocationKernel;
39 using IImage = ITensor;
40 
41 /** Basic function to execute min and max location. This function calls the following Neon kernels:
42  *
43  * -# NEMinMaxKernel
44  * -# NEMinMaxLocationKernel
45  *
46  * @deprecated This function is deprecated and is intended to be removed in 21.05 release
47  *
48  */
50 {
51 public:
52  /** Constructor */
54  /** Prevent instances of this class from being copied (As this class contains pointers) */
55  NEMinMaxLocation(const NEMinMaxLocation &) = delete;
56  /** Prevent instances of this class from being copied (As this class contains pointers) */
57  NEMinMaxLocation &operator=(const NEMinMaxLocation &) = delete;
58  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
60  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
62  /** Default destructor */
64  /** Initialise the kernel's inputs and outputs.
65  *
66  * @param[in] input Input image. Data types supported: U8/S16/F32.
67  * @param[out] min Minimum value of image. Data types supported: S32 if input type is U8/S16, F32 if input type is F32.
68  * @param[out] max Maximum value of image. Data types supported: S32 if input type is U8/S16, F32 if input type is F32.
69  * @param[out] min_loc (Optional) Array of minimum value locations.
70  * @param[out] max_loc (Optional) Array of maximum value locations.
71  * @param[out] min_count (Optional) Number of minimum value encounters.
72  * @param[out] max_count (Optional) Number of maximum value encounters.
73  */
74  void configure(const IImage *input, void *min, void *max,
75  ICoordinates2DArray *min_loc = nullptr, ICoordinates2DArray *max_loc = nullptr,
76  uint32_t *min_count = nullptr, uint32_t *max_count = nullptr);
77 
78  // Inherited methods overridden:
79  void run() override;
80 
81 private:
82  std::unique_ptr<NEMinMaxKernel> _min_max; /**< Kernel that performs min/max */
83  std::unique_ptr<NEMinMaxLocationKernel> _min_max_loc; /**< Kernel that extracts min/max locations */
84 };
85 }
86 #endif /*ARM_COMPUTE_NEMINMAXLOCATION_H */
NEMinMaxLocation & operator=(const NEMinMaxLocation &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
Base class for all functions.
Definition: IFunction.h:30
Array of type T.
Definition: IArray.h:40
Basic function to execute min and max location.
void run() override
Run the kernels contained in the function.
Interface for Neon tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2021 Arm Limited.
ITensor IImage
Interface for CPP Images.
void configure(const IImage *input, void *min, void *max, ICoordinates2DArray *min_loc=nullptr, ICoordinates2DArray *max_loc=nullptr, uint32_t *min_count=nullptr, uint32_t *max_count=nullptr)
Initialise the kernel&#39;s inputs and outputs.
~NEMinMaxLocation()
Default destructor.