Compute Library
 22.05
CLReduceMean.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_CL_REDUCE_MEAN_H
25 #define ARM_COMPUTE_CL_REDUCE_MEAN_H
26 
34 
35 namespace arm_compute
36 {
37 // Forward Declarations
38 class ICLTensor;
39 
40 /** Basic function to perform reduce operation */
41 class CLReduceMean : public IFunction
42 {
43 public:
44  /** Default constructor */
45  CLReduceMean(std::shared_ptr<IMemoryManager> memory_manager = nullptr);
46  /** Configure kernel
47  *
48  * Valid data layouts:
49  * - All
50  *
51  * Valid data type configurations:
52  * |src |dst |
53  * |:--------------|:--------------|
54  * |QASYMM8 |QASYMM8 |
55  * |QASYMM8_SIGNED |QASYMM8_SIGNED |
56  * |F16 |F16 |
57  * |F32 |F32 |
58  *
59  * @note Supported tensor rank: up to 4
60  *
61  * @param[in] input Source tensor. Data type supported: QASYMM8/QASYMM8_SIGNED/F16/F32
62  * @param[in] reduction_axis Reduction axis vector.
63  * @param[in] keep_dims If positive, retains reduced dimensions with length 1.
64  * @param[out] output Destination tensor. Data type supported: Same as @p input
65  */
66  void configure(ICLTensor *input, const Coordinates &reduction_axis, bool keep_dims, ICLTensor *output);
67  /** Configure kernel
68  *
69  * @note Supported tensor rank: up to 4
70  *
71  * @param[in] compile_context The compile context to be used.
72  * @param[in] input Source tensor. Data type supported: QASYMM8/QASYMM8_SIGNED/F16/F32
73  * @param[in] reduction_axis Reduction axis vector.
74  * @param[in] keep_dims If positive, retains reduced dimensions with length 1.
75  * @param[out] output Destination tensor. Data type supported: Same as @p input
76  */
77  void configure(const CLCompileContext &compile_context, ICLTensor *input, const Coordinates &reduction_axis, bool keep_dims, ICLTensor *output);
78 
79  /** Static function to check if given info will lead to a valid configuration of @ref CLReduceMean
80  *
81  * @param[in] input Source tensor. Data type supported: QASYMM8/QASYMM8_SIGNED/F16/F32
82  * @param[in] reduction_axis Reduction axis vector.
83  * @param[in] keep_dims If positive, retains reduced dimensions with length 1.
84  * @param[in] output Destination tensor. Data type supported: Same as @p input
85  *
86  * @return A status
87  */
88  static Status validate(const ITensorInfo *input, const Coordinates &reduction_axis, bool keep_dims, const ITensorInfo *output);
89 
90  // Inherited methods overridden:
91  void run() override;
92 
93 private:
94  MemoryGroup _memory_group;
95  std::vector<CLReductionOperation> _reduction_kernels;
96  std::vector<CLTensor> _reduced_outs;
97  CLReshapeLayer _reshape;
98  CLDequantizationLayer _dequant;
99  CLQuantizationLayer _requant;
100  int _reduction_ops;
101  bool _keep_dims;
102  bool _do_requant;
103  CLTensor _input_no_quant;
104  CLTensor _output_no_quant;
105 };
106 } // namespace arm_compute
107 #endif /* ARM_COMPUTE_CL_REDUCE_MEAN_H */
Base class for all functions.
Definition: IFunction.h:30
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Basic function to run opencl::ClDequantize that dequantizes an input tensor.
void configure(ICLTensor *input, const Coordinates &reduction_axis, bool keep_dims, ICLTensor *output)
Configure kernel.
Copyright (c) 2017-2022 Arm Limited.
void run() override
Run the kernels contained in the function.
Coordinates of an item.
Definition: Coordinates.h:37
CLCompileContext class.
static Status validate(const ITensorInfo *input, const Coordinates &reduction_axis, bool keep_dims, const ITensorInfo *output)
Static function to check if given info will lead to a valid configuration of CLReduceMean.
Basic function to perform reduce operation.
Definition: CLReduceMean.h:41
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
CLReduceMean(std::shared_ptr< IMemoryManager > memory_manager=nullptr)
Default constructor.
Basic function to run opencl::kernels::ClReshapeKernel.
Basic function to simulate a quantization layer.
Basic implementation of the OpenCL tensor interface.
Definition: CLTensor.h:41