Compute Library
 22.05
CLArgMinMaxLayer.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018-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_CLARGMINMAXLAYER_H
25 #define ARM_COMPUTE_CLARGMINMAXLAYER_H
26 
27 #include "arm_compute/core/Types.h"
33 
34 namespace arm_compute
35 {
36 class ITensorInfo;
37 class ICLTensor;
38 class CLArgMinMaxLayerKernel;
39 
40 /** Function to calculate the index of the minimum or maximum values in a
41  * tensor based on an axis.
42  *
43  * @note The default data type for an uninitialized output tensor is
44  * signed 32-bit integer (S32). It is the user's responsibility to check
45  * that the results do not overflow because the indices are computed
46  * in unsigned 32-bit (U32).
47  */
49 {
50 public:
51  /** Default Constructor.
52  *
53  * @param[in] memory_manager (Optional) Memory manager.
54  */
55  CLArgMinMaxLayer(std::shared_ptr<IMemoryManager> memory_manager = nullptr);
56  /** Prevent instances of this class from being copied */
57  CLArgMinMaxLayer(const CLArgMinMaxLayer &) = delete;
58  /** Prevent instances of this class from being copied */
59  CLArgMinMaxLayer &operator=(const CLArgMinMaxLayer &) = delete;
60  /** Prevent instances of this class to be moved */
62  /** Prevent instances of this class to be moved */
64  /** Default destructor */
66  /** Set the input and output tensors.
67  *
68  * Valid data layouts:
69  * - All
70  *
71  * Valid data type configurations:
72  * |src |dst |
73  * |:--------------|:---------|
74  * |QASYMM8 |U32, S32 |
75  * |QASYMM8_SIGNED |U32, S32 |
76  * |S32 |U32, S32 |
77  * |F16 |U32, S32 |
78  * |F32 |U32, S32 |
79  *
80  * @param[in] input Input source tensor. Data types supported: QASYMM8/QASYMM8_SIGNED/S32/F16/F32.
81  * @param[in] axis Axis to find max/min index.
82  * @param[out] output Output source tensor. Data types supported: U32/S32.
83  * @param[in] op Reduction operation to perform. Operations supported: ARG_IDX_MAX, ARG_IDX_MIN
84  */
85  void configure(const ICLTensor *input, int axis, ICLTensor *output, const ReductionOperation &op);
86  /** Set the input and output tensors.
87  *
88  * @param[in] compile_context The compile context to be used.
89  * @param[in] input Input source tensor. Data types supported: QASYMM8/QASYMM8_SIGNED/S32/F16/F32.
90  * @param[in] axis Axis to find max/min index.
91  * @param[out] output Output source tensor. Data types supported: U32/S32.
92  * @param[in] op Reduction operation to perform. Operations supported: ARG_IDX_MAX, ARG_IDX_MIN
93  */
94  void configure(const CLCompileContext &compile_context, const ICLTensor *input, int axis, ICLTensor *output, const ReductionOperation &op);
95  /** Static function to check if given info will lead to a valid configuration of @ref CLArgMinMaxLayer
96  *
97  * @param[in] input Input source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/S32/F16/F32.
98  * @param[in] axis Axis to find max/min index.
99  * @param[in] output Output source tensor info. Data types supported: U32/S32.
100  * @param[in] op Reduction operation to perform. Operations supported: ARG_IDX_MAX, ARG_IDX_MIN
101  *
102  * @return a status
103  */
104  static Status validate(const ITensorInfo *input, int axis, const ITensorInfo *output, const ReductionOperation &op);
105 
106  // Inherited methods overridden:
107  void run() override;
108 
109 private:
110  MemoryGroup _memory_group;
111  std::vector<CLTensor> _results_vector;
112  CLTensor _not_reshaped_output;
113  std::vector<std::unique_ptr<CLArgMinMaxLayerKernel>> _reduction_kernels_vector;
114  CLReshapeLayer _reshape;
115  unsigned int _num_of_stages;
116  unsigned int _reduction_axis;
117 };
118 } // namespace arm_compute
119 #endif /* ARM_COMPUTE_CLARGMINMAXLAYER_H */
~CLArgMinMaxLayer()
Default destructor.
Base class for all functions.
Definition: IFunction.h:30
ReductionOperation
Available reduction operations.
Definition: Types.h:476
void run() override
Run the kernels contained in the function.
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Copyright (c) 2017-2022 Arm Limited.
static Status validate(const ITensorInfo *input, int axis, const ITensorInfo *output, const ReductionOperation &op)
Static function to check if given info will lead to a valid configuration of CLArgMinMaxLayer.
CLArgMinMaxLayer(std::shared_ptr< IMemoryManager > memory_manager=nullptr)
Default Constructor.
CLCompileContext class.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
Function to calculate the index of the minimum or maximum values in a tensor based on an axis...
void configure(const ICLTensor *input, int axis, ICLTensor *output, const ReductionOperation &op)
Set the input and output tensors.
CLArgMinMaxLayer & operator=(const CLArgMinMaxLayer &)=delete
Prevent instances of this class from being copied.
Basic function to run opencl::kernels::ClReshapeKernel.
Basic implementation of the OpenCL tensor interface.
Definition: CLTensor.h:41