1 /* 2 * Copyright (c) 2017-2020 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 27 #include "arm_compute/runtime/CL/CLTensor.h" 28 #include "arm_compute/runtime/CL/functions/CLReshapeLayer.h" 29 #include "arm_compute/runtime/IFunction.h" 30 #include "arm_compute/runtime/IMemoryManager.h" 31 #include "arm_compute/runtime/MemoryGroup.h" 32 33 #include <memory> 34 35 namespace arm_compute 36 { 37 // Forward declarations 38 class CLCompileContext; 39 class CLFillBorderKernel; 40 class CLReductionOperationKernel; 41 class ICLTensor; 42 43 /** Perform reduction operation. 44 */ 45 class CLReductionOperation : public IFunction 46 { 47 public: 48 /** Default Constructor. 49 * 50 * @param[in] memory_manager (Optional) Memory manager. 51 */ 52 CLReductionOperation(std::shared_ptr<IMemoryManager> memory_manager = nullptr); 53 /** Default Destructor */ 54 ~CLReductionOperation(); 55 /** Prevent instances of this class from being copied (As this class contains pointers) */ 56 CLReductionOperation(const CLReductionOperation &) = delete; 57 /** Default move constructor */ 58 CLReductionOperation(CLReductionOperation &&) = default; 59 /** Prevent instances of this class from being copied (As this class contains pointers) */ 60 CLReductionOperation &operator=(const CLReductionOperation &) = delete; 61 /** Default move assignment operator */ 62 CLReductionOperation &operator=(CLReductionOperation &&) = default; 63 64 /** Set the input and output tensors. 65 * 66 * @param[in] input Source tensor. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32/S32. 67 * @param[out] output Destination tensor. Data types and data layouts supported: Same as @p input. 68 * @param[in] axis Axis along which to reduce. Supported reduction axis : 0, 1, 2, 3 69 * @param[in] op Reduction operation to perform. Operations supported: MEAN_SUM, PROD, SUM_SQUARE, SUM, MIN, MAX 70 * @param[in] keep_dims (Optional) Whether to keep the reduced dimension after the operation. Defaults to true. 71 */ 72 void configure(ICLTensor *input, ICLTensor *output, unsigned int axis, ReductionOperation op, bool keep_dims = true); 73 /** Set the input and output tensors. 74 * 75 * @param[in] compile_context The compile context to be used. 76 * @param[in] input Source tensor. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32/S32. 77 * @param[out] output Destination tensor. Data types and data layouts supported: Same as @p input. 78 * @param[in] axis Axis along which to reduce. Supported reduction axis : 0, 1, 2, 3 79 * @param[in] op Reduction operation to perform. Operations supported: MEAN_SUM, PROD, SUM_SQUARE, SUM, MIN, MAX 80 * @param[in] keep_dims (Optional) Whether to keep the reduced dimension after the operation. Defaults to true. 81 */ 82 void configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output, unsigned int axis, ReductionOperation op, bool keep_dims = true); 83 84 /** Static function to check if given info will lead to a valid configuration of @ref CLReductionOperation. 85 * 86 * @param[in] input Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/F32/S32. 87 * @param[in] output Destination tensor info. Data types and data layouts supported: Same as @p input. 88 * @param[in] axis Axis along which to reduce. Supported reduction axis : 0, 1, 2, 3 89 * @param[in] op Reduction operation to perform. Operations supported: MEAN_SUM, PROD, SUM_SQUARE, SUM, MIN, MAX 90 * @param[in] keep_dims (Optional) Whether to keep the reduced dimension after the operation. Defaults to true. 91 * 92 * @return a status 93 */ 94 static Status validate(const ITensorInfo *input, const ITensorInfo *output, unsigned int axis, ReductionOperation op, bool keep_dims = true); 95 96 // Inherited methods overridden: 97 void run() override; 98 99 private: 100 ICLTensor *configure_intermediate_result_vector(ICLTensor *input, ICLTensor *output); 101 102 MemoryGroup _memory_group; 103 std::vector<CLTensor> _results_vector; 104 std::vector<std::unique_ptr<CLReductionOperationKernel>> _reduction_kernels_vector; 105 std::vector<std::unique_ptr<CLFillBorderKernel>> _border_handlers_vector; 106 CLReshapeLayer _reshape; 107 unsigned int _num_of_stages; 108 unsigned int _reduction_axis; 109 bool _is_serial; 110 bool _is_reshape_required; 111 }; 112 } // namespace arm_compute 113 #endif /* ARM_COMPUTE_CLREDUCTIONOPERATION_H */