Compute Library
 21.05
CLReductionOperationKernel.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_CLREDUCTIONOPERATIONKERNEL_H
25 #define ARM_COMPUTE_CLREDUCTIONOPERATIONKERNEL_H
26 
27 #include "arm_compute/core/Types.h"
28 #include "src/core/CL/ICLKernel.h"
29 
30 namespace arm_compute
31 {
32 class ICLTensor;
33 
34 /** Interface for the reduction operation kernel
35  */
37 {
38 public:
39  /** Default constructor */
41  /** Prevent instances of this class from being copied (As this class contains pointers) */
43  /** Prevent instances of this class from being copied (As this class contains pointers) */
45  /** Allow instances of this class to be moved */
47  /** Allow instances of this class to be moved */
49  /** Default destructor */
50  ~CLReductionOperationKernel() = default;
51 
52  /** Set the input and output tensors.
53  *
54  * @param[in] input Source tensor. Data types supported: QASYMM8/QASYMM8_SIGNED/S32/F16/F32.
55  * @param[out] output Destination tensor. Data types and data layouts supported: Same as @p input.
56  * Output will have the same number of dimensions as input.
57  * @param[in] axis Axis along which to reduce. Supported reduction axis : 0,1,2,3
58  * @param[in] op Reduction operation to perform. Operations supported: MEAN_SUM, PROD, SUM_SQUARE, SUM, MIN, MAX
59  */
60  void configure(const ICLTensor *input, ICLTensor *output, unsigned int axis, ReductionOperation op);
61  /** Set the input and output tensors.
62  *
63  * @param[in] compile_context The compile context to be used.
64  * @param[in] input Source tensor. Data types supported: QASYMM8/QASYMM8_SIGNED/S32/F16/F32.
65  * @param[out] output Destination tensor. Data types and data layouts supported: Same as @p input.
66  * Output will have the same number of dimensions as input.
67  * @param[in] axis Axis along which to reduce. Supported reduction axis : 0,1,2,3
68  * @param[in] op Reduction operation to perform. Operations supported: MEAN_SUM, PROD, SUM_SQUARE, SUM, MIN, MAX
69  */
70  void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, unsigned int axis, ReductionOperation op);
71 
72  /** Static function to check if given info will lead to a valid configuration of @ref CLReductionOperationKernel.
73  *
74  * @param[in] input Source tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/S32/F16/F32.
75  * @param[in] output Destination tensor info. Data types and data layouts supported: Same as @p input.
76  * Output will have the same number of dimensions as input.
77  * @param[in] axis Axis along which to reduce. Supported reduction axis : 0,1,2,3
78  * @param[in] op Reduction operation to perform. Operations supported: MEAN_SUM, PROD, SUM_SQUARE, SUM, MIN, MAX
79  *
80  * @return a status
81  */
82  static Status validate(const ITensorInfo *input, const ITensorInfo *output, unsigned int axis, ReductionOperation op);
83 
84  // Inherited methods overridden:
85  void run(const Window &window, cl::CommandQueue &queue) override;
86 
87 private:
88  const ICLTensor *_input;
89  ICLTensor *_output;
90  unsigned int _reduction_axis;
92 };
93 } // namespace arm_compute
94 #endif /*ARM_COMPUTE_CLREDUCTIONOPERATIONKERNEL_H */
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
~CLReductionOperationKernel()=default
Default destructor.
ReductionOperation
Available reduction operations.
Definition: Types.h:457
Store the tensor's metadata.
Definition: ITensorInfo.h:40
void configure(const ICLTensor *input, ICLTensor *output, unsigned int axis, ReductionOperation op)
Set the input and output tensors.
Status class.
Definition: Error.h:52
Interface for the reduction operation kernel.
Common interface for all the OpenCL kernels.
Definition: ICLKernel.h:46
void run(const Window &window, cl::CommandQueue &queue) override
Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue.
Copyright (c) 2017-2021 Arm Limited.
CLCompileContext class.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
CLReductionOperationKernel & operator=(const CLReductionOperationKernel &)=delete
Prevent instances of this class from being copied (As this class contains pointers)
static Status validate(const ITensorInfo *input, const ITensorInfo *output, unsigned int axis, ReductionOperation op)
Static function to check if given info will lead to a valid configuration of CLReductionOperationKern...
Describe a multidimensional execution window.
Definition: Window.h:39