Compute Library
 22.08
NEReduceMean.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_NEON_REDUCE_MEAN_H
25 #define ARM_COMPUTE_NEON_REDUCE_MEAN_H
26 
28 
29 #include "arm_compute/core/Types.h"
36 
37 namespace arm_compute
38 {
39 /** Basic function to perform reduce operation */
40 class NEReduceMean : public IFunction
41 {
42 public:
43  /** Constructor */
44  NEReduceMean(std::shared_ptr<IMemoryManager> memory_manager = nullptr);
45  /** Prevent instances of this class from being copied (As this class contains pointers) */
46  NEReduceMean(const NEReduceMean &) = delete;
47  /** Prevent instances of this class from being copied (As this class contains pointers) */
48  NEReduceMean &operator=(const NEReduceMean &) = delete;
49  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
50  NEReduceMean(NEReduceMean &&) = delete;
51  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
52  NEReduceMean &operator=(NEReduceMean &&) = delete;
53  /** Default destructor */
54  ~NEReduceMean();
55  /** Configure kernel
56  *
57  * Valid data layouts:
58  * - All
59  *
60  * Valid data type configurations:
61  * |src |dst |
62  * |:--------------|:--------------|
63  * |QASYMM8 |QASYMM8 |
64  * |QASYMM8_SIGNED |QASYMM8_SIGNED |
65  * |F16 |F16 |
66  * |F32 |F32 |
67  *
68  * @note Supported tensor rank: up to 4
69  *
70  * @param[in] input Source tensor. Data type supported: QASYMM8_SIGNED/QASYMM8/F16/F32
71  * @param[in] reduction_axis Reduction axis vector.
72  * @param[in] keep_dims If positive, retains reduced dimensions with length 1.
73  * @param[out] output Destination tensor. Data type supported: Same as @p input
74  */
75  void configure(ITensor *input, const Coordinates &reduction_axis, bool keep_dims, ITensor *output);
76 
77  /** Static function to check if given info will lead to a valid configuration of @ref NEReduceMean
78  *
79  * @param[in] input Source tensor. Data type supported: QASYMM8_SIGNED/QASYMM8/F16/F32
80  * @param[in] reduction_axis Reduction axis vector.
81  * @param[in] keep_dims If positive, retains reduced dimensions with length 1.
82  * @param[in] output Destination tensor. Data type supported: Same as @p input
83  *
84  * @return A status
85  */
86  static Status validate(const ITensorInfo *input, const Coordinates &reduction_axis, bool keep_dims, const ITensorInfo *output);
87 
88  // Inherited methods overridden:
89  void run() override;
90 
91 private:
92  MemoryGroup _memory_group;
93  std::vector<NEReductionOperation> _reduction_kernels;
94  std::vector<Tensor> _reduced_outs;
95  NEReshapeLayer _reshape;
96  NEDequantizationLayer _dequant;
97  NEQuantizationLayer _requant;
98  int _reduction_ops;
99  bool _keep_dims;
100  bool _do_requant;
101  Tensor _input_no_quant;
102  Tensor _output_no_quant;
103 };
104 } // namespace arm_compute
105 #endif /* ARM_COMPUTE_NEON_REDUCE_MEAN_H */
Base class for all functions.
Definition: IFunction.h:30
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
Basic function to run a quantization layer using cpu::CpuQuantize.
Status class.
Definition: Error.h:52
~NEReduceMean()
Default destructor.
Interface for CPU tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2022 Arm Limited.
Coordinates of an item.
Definition: Coordinates.h:37
void configure(ITensor *input, const Coordinates &reduction_axis, bool keep_dims, ITensor *output)
Configure kernel.
Basic implementation of the tensor interface.
Definition: Tensor.h:37
Basic function to run cpu::CpuDequantize that dequantizes an input tensor.
NEReduceMean(std::shared_ptr< IMemoryManager > memory_manager=nullptr)
Constructor.
Basic function to run cpu::kernels::CpuReshapeKernel.
Basic function to perform reduce operation.
Definition: NEReduceMean.h:40
NEReduceMean & operator=(const NEReduceMean &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
void run() override
Run the kernels contained in the function.
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 NEReduceMean.