Compute Library
 22.05
CLReductionOperation.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-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_CLREDUCTIONOPERATION_H
25 #define ARM_COMPUTE_CLREDUCTIONOPERATION_H
26 
32 
33 #include <memory>
34 
35 namespace arm_compute
36 {
37 // Forward declarations
38 class CLCompileContext;
39 class CLReductionOperationKernel;
40 class ICLTensor;
41 
42 /** Perform reduction operation.
43  */
45 {
46 public:
47  /** Default Constructor.
48  *
49  * @param[in] memory_manager (Optional) Memory manager.
50  */
51  CLReductionOperation(std::shared_ptr<IMemoryManager> memory_manager = nullptr);
52  /** Default Destructor */
54  /** Prevent instances of this class from being copied (As this class contains pointers) */
56  /** Default move constructor */
58  /** Prevent instances of this class from being copied (As this class contains pointers) */
60  /** Default move assignment operator */
62 
63  /** Set the input and output tensors.
64  *
65  * Valid data layouts:
66  * - All
67  *
68  * Valid data type configurations:
69  * |src |dst |
70  * |:--------------|:--------------|
71  * |QASYMM8 |QASYMM8 |
72  * |QASYMM8_SIGNED |QASYMM8_SIGNED |
73  * |F16 |F16 |
74  * |F32 |F32 |
75  * |S32 |S32 |
76  *
77  * @param[in] input Source tensor. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32/S32.
78  * @param[out] output Destination tensor. Data types and data layouts supported: Same as @p input.
79  * @param[in] axis Axis along which to reduce. Supported reduction axis : 0, 1, 2, 3
80  * @param[in] op Reduction operation to perform. Operations supported: MEAN_SUM, PROD, SUM_SQUARE, SUM, MIN, MAX
81  * @param[in] keep_dims (Optional) Whether to keep the reduced dimension after the operation. Defaults to true.
82  */
83  void configure(ICLTensor *input, ICLTensor *output, unsigned int axis, ReductionOperation op, bool keep_dims = true);
84  /** Set the input and output tensors.
85  *
86  * @param[in] compile_context The compile context to be used.
87  * @param[in] input Source tensor. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32/S32.
88  * @param[out] output Destination tensor. Data types and data layouts supported: Same as @p input.
89  * @param[in] axis Axis along which to reduce. Supported reduction axis : 0, 1, 2, 3
90  * @param[in] op Reduction operation to perform. Operations supported: MEAN_SUM, PROD, SUM_SQUARE, SUM, MIN, MAX
91  * @param[in] keep_dims (Optional) Whether to keep the reduced dimension after the operation. Defaults to true.
92  */
93  void configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output, unsigned int axis, ReductionOperation op, bool keep_dims = true);
94 
95  /** Static function to check if given info will lead to a valid configuration of @ref CLReductionOperation.
96  *
97  * @param[in] input Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32/S32.
98  * @param[in] output Destination tensor info. Data types and data layouts supported: Same as @p input.
99  * @param[in] axis Axis along which to reduce. Supported reduction axis : 0, 1, 2, 3
100  * @param[in] op Reduction operation to perform. Operations supported: MEAN_SUM, PROD, SUM_SQUARE, SUM, MIN, MAX
101  * @param[in] keep_dims (Optional) Whether to keep the reduced dimension after the operation. Defaults to true.
102  *
103  * @return a status
104  */
105  static Status validate(const ITensorInfo *input, const ITensorInfo *output, unsigned int axis, ReductionOperation op, bool keep_dims = true);
106 
107  // Inherited methods overridden:
108  void run() override;
109 
110 private:
111  ICLTensor *configure_intermediate_result_vector(ICLTensor *input, ICLTensor *output);
112 
113  MemoryGroup _memory_group;
114  CLTensor _unreshaped_output;
115  std::unique_ptr<CLReductionOperationKernel> _reduction_kernel;
116  CLReshapeLayer _reshape;
117  unsigned int _reduction_axis;
118  bool _is_reshape_required;
119 };
120 } // namespace arm_compute
121 #endif /* ARM_COMPUTE_CLREDUCTIONOPERATION_H */
Base class for all functions.
Definition: IFunction.h:30
ReductionOperation
Available reduction operations.
Definition: Types.h:476
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Copyright (c) 2017-2022 Arm Limited.
CLReductionOperation & operator=(const CLReductionOperation &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
void run() override
Run the kernels contained in the function.
CLReductionOperation(std::shared_ptr< IMemoryManager > memory_manager=nullptr)
Default Constructor.
static Status validate(const ITensorInfo *input, const ITensorInfo *output, unsigned int axis, ReductionOperation op, bool keep_dims=true)
Static function to check if given info will lead to a valid configuration of CLReductionOperation.
CLCompileContext class.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
Perform reduction operation.
void configure(ICLTensor *input, ICLTensor *output, unsigned int axis, ReductionOperation op, bool keep_dims=true)
Set the input and output tensors.
Basic function to run opencl::kernels::ClReshapeKernel.
~CLReductionOperation()
Default Destructor.
Basic implementation of the OpenCL tensor interface.
Definition: CLTensor.h:41