Compute Library
 21.05
NEReductionOperation.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_NEREDUCTIONOPERATION_H
25 #define ARM_COMPUTE_NEREDUCTIONOPERATION_H
26 
28 
31 #include <memory>
32 
33 namespace arm_compute
34 {
35 class ITensor;
36 class NEReductionOperationKernel;
37 
38 /** Basic function to simulate a reduction operation. This function calls the following kernels:
39  *
40  * -# @ref NEReshapeLayer
41  * -# @ref NEReductionOperationKernel
42  *
43  */
45 {
46 public:
47  /** Default constructor */
48  NEReductionOperation(std::shared_ptr<IMemoryManager> memory_manager = nullptr);
49  /** Prevent instances of this class from being copied (As this class contains pointers) */
51  /** Default move constructor */
53  /** Prevent instances of this class from being copied (As this class contains pointers) */
55  /** Default move assignment operator */
57  /** Default destructor */
59  /** Set the input and output tensors.
60  *
61  * Valid data layouts:
62  * - All
63  *
64  * Valid data type configurations:
65  * |src |dst |
66  * |:--------------|:--------------|
67  * |QASYMM8 |QASYMM8 |
68  * |QASYMM8_SIGNED |QASYMM8_SIGNED |
69  * |F16 |F16 |
70  * |F32 |F32 |
71  * |S32 |S32 |
72  *
73  * @param[in, out] input Source tensor. Data type supported: QASYMM8_SIGNED/QASYMM8/F16/F32/S32. (Written to only for border_size != 0)
74  * @param[out] output Destination tensor. Data types and data layouts supported: same as @p input.
75  * @param[in] axis Dimension along which to reduce. Supported reduction axis : 0
76  * @param[in] op Reduction operation to perform.
77  * @param[in] keep_dims (Optional) Whether to keep the reduced dimension after the operation. Defaults to true.
78  */
79  void configure(ITensor *input, ITensor *output, unsigned int axis, ReductionOperation op, bool keep_dims = true);
80 
81  /** Static function to check if given info will lead to a valid configuration of @ref NEReductionOperation.
82  *
83  * @param[in] input Source tensor info. Data type supported: QASYMM8_SIGNED/QASYMM8/F16/F32/S32.
84  * @param[in] output Destination tensor info. Data types and data layouts supported: same as @p input.
85  * @param[in] axis Dimension along which to reduce. Supported reduction axis : 0
86  * @param[in] op Reduction operation to perform.
87  * @param[in] keep_dims (Optional) Whether to keep the reduced dimension after the operation. Defaults to true.
88  *
89  * @return a status
90  */
91  static Status validate(const ITensorInfo *input, const ITensorInfo *output, unsigned int axis, ReductionOperation op, bool keep_dims = true);
92 
93  // Inherited methods overridden:
94  void run() override;
95 
96 private:
97  MemoryGroup _memory_group;
98  std::unique_ptr<NEReductionOperationKernel> _reduction_kernel;
99  NEReshapeLayer _reshape;
100  Tensor _output_internal;
101  size_t _window_split;
102  int _reduction_axis;
103  bool _is_reshape_required;
104 };
105 } // namespace arm_compute
106 #endif /* ARM_COMPUTE_NEREDUCTIONOPERATION_H */
Base class for all functions.
Definition: IFunction.h:30
void run() override
Run the kernels contained in the function.
ReductionOperation
Available reduction operations.
Definition: Types.h:457
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Interface for CPU tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2021 Arm Limited.
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 NEReductionOperation.
Basic implementation of the tensor interface.
Definition: Tensor.h:37
~NEReductionOperation()
Default destructor.
Basic function to run cpu::kernels::CpuReshapeKernel.
Basic function to simulate a reduction operation.
NEReductionOperation & operator=(const NEReductionOperation &)=delete
Prevent instances of this class from being copied (As this class contains pointers)
NEReductionOperation(std::shared_ptr< IMemoryManager > memory_manager=nullptr)
Default constructor.
void configure(ITensor *input, ITensor *output, unsigned int axis, ReductionOperation op, bool keep_dims=true)
Set the input and output tensors.