xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/runtime/NEON/functions/NEReduceMean.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2018-2022 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 
27 #include "arm_compute/runtime/IFunction.h"
28 
29 #include "arm_compute/core/Types.h"
30 #include "arm_compute/runtime/MemoryGroup.h"
31 #include "arm_compute/runtime/NEON/functions/NEReductionOperation.h"
32 #include "arm_compute/runtime/NEON/functions/NEReshapeLayer.h"
33 #include "arm_compute/runtime/Tensor.h"
34 
35 namespace arm_compute
36 {
37 /** Basic function to perform reduce operation */
38 class NEReduceMean : public IFunction
39 {
40 public:
41     /** Constructor */
42     NEReduceMean(std::shared_ptr<IMemoryManager> memory_manager = nullptr);
43     /** Prevent instances of this class from being copied (As this class contains pointers) */
44     NEReduceMean(const NEReduceMean &) = delete;
45     /** Prevent instances of this class from being copied (As this class contains pointers) */
46     NEReduceMean &operator=(const NEReduceMean &) = delete;
47     /** Prevent instances of this class from being moved (As this class contains non movable objects) */
48     NEReduceMean(NEReduceMean &&) = delete;
49     /** Prevent instances of this class from being moved (As this class contains non movable objects) */
50     NEReduceMean &operator=(NEReduceMean &&) = delete;
51     /** Default destructor */
52     ~NEReduceMean();
53     /** Configure kernel
54      *
55      * Valid data layouts:
56      * - All
57      *
58      * Valid data type configurations:
59      * |src            |dst            |
60      * |:--------------|:--------------|
61      * |QASYMM8        |QASYMM8        |
62      * |QASYMM8_SIGNED |QASYMM8_SIGNED |
63      * |F16            |F16            |
64      * |F32            |F32            |
65      *
66      * @note Supported tensor rank: up to 4
67      *
68      * @param[in]  input          Source tensor. Data type supported: QASYMM8_SIGNED/QASYMM8/F16/F32
69      * @param[in]  reduction_axis Reduction axis vector.
70      * @param[in]  keep_dims      If positive, retains reduced dimensions with length 1.
71      * @param[out] output         Destination tensor. Data type supported: Same as @p input
72      */
73     void configure(ITensor *input, const Coordinates &reduction_axis, bool keep_dims, ITensor *output);
74 
75     /** Static function to check if given info will lead to a valid configuration of @ref NEReduceMean
76      *
77      * @param[in] input          Source tensor. Data type supported: QASYMM8_SIGNED/QASYMM8/F16/F32
78      * @param[in] reduction_axis Reduction axis vector.
79      * @param[in] keep_dims      If positive, retains reduced dimensions with length 1.
80      * @param[in] output         Destination tensor. Data type supported: Same as @p input
81      *
82      * @return A status
83      */
84     static Status validate(const ITensorInfo *input, const Coordinates &reduction_axis, bool keep_dims, const ITensorInfo *output);
85 
86     // Inherited methods overridden:
87     void run() override;
88 
89 private:
90     MemoryGroup                       _memory_group;
91     std::vector<NEReductionOperation> _reduction_kernels;
92     std::vector<Tensor>               _reduced_outs;
93     NEReshapeLayer                    _reshape;
94     int                               _reduction_ops;
95     bool                              _keep_dims;
96 };
97 } // namespace arm_compute
98 #endif /* ARM_COMPUTE_NEON_REDUCE_MEAN_H */
99