Compute Library
 22.05
CLGatherKernel.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018-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_CLGATHERKERNEL_H
25 #define ARM_COMPUTE_CLGATHERKERNEL_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 kernel to perform tensor reshaping */
35 class CLGatherKernel : public ICLKernel
36 {
37 public:
38  /** Default constructor */
40  /** Prevent instances of this class from being copied (As this class contains pointers) */
41  CLGatherKernel(const CLGatherKernel &) = delete;
42  /** Prevent instances of this class from being copied (As this class contains pointers) */
43  CLGatherKernel &operator=(const CLGatherKernel &) = delete;
44  /** Allow instances of this class to be moved */
45  CLGatherKernel(CLGatherKernel &&) = default;
46  /** Allow instances of this class to be moved */
48  /** Default destructor */
49  ~CLGatherKernel() = default;
50  /** Initialise the kernel's inputs and outputs
51  *
52  * @param[in] input Source tensor. Supported tensor rank: up to 4. Data type supported: All.
53  * @param[in] indices Indices tensor. Supported tensor rank: up to 1. Must be one of the following types: U32/S32. Each value must be in range [0, input.shape[@p axis])
54  * @param[out] output Destination tensor. Data type supported: Same as @p input
55  * @param[in] axis (Optional) The axis in @p input to gather @p indices from. Negative values wrap around. Defaults to 0
56  */
57  void configure(const ICLTensor *input, const ICLTensor *indices, ICLTensor *output, int axis = 0);
58  /** Initialise the kernel's inputs and outputs
59  *
60  * @param[in] compile_context The compile context to be used.
61  * @param[in] input Source tensor. Supported tensor rank: up to 4. Data type supported: All.
62  * @param[in] indices Indices tensor. Supported tensor rank: up to 1. Must be one of the following types: U32/S32. Each value must be in range [0, input.shape[@p axis])
63  * @param[out] output Destination tensor. Data type supported: Same as @p input
64  * @param[in] axis (Optional) The axis in @p input to gather @p indices from. Negative values wrap around. Defaults to 0
65  */
66  void configure(const CLCompileContext &compile_context, const ICLTensor *input, const ICLTensor *indices, ICLTensor *output, int axis = 0);
67 
68  /** Static function to check if given info will lead to a valid configuration of @ref CLGatherKernel
69  *
70  * @param[in] input Source tensor info. Supported tensor rank: up to 4. Data type supported: All.
71  * @param[in] indices Indices tensor info. Supported tensor rank: up to 4. Must be one of the following types: U32/S32. Each value must be in range [0, input.shape[@p axis])
72  * @param[in] output Destination tensor info. Data type supported: Same as @p input
73  * @param[in] axis (Optional) The axis in @p input to gather @p indices from. Negative values wrap around. Defaults to 0
74  *
75  * @return a status
76  */
77  static Status validate(const ITensorInfo *input, const ITensorInfo *indices, const ITensorInfo *output, int axis = 0);
78 
79  // Inherited methods overridden:
80  void run(const Window &window, cl::CommandQueue &queue) override;
81 
82 private:
83  const ICLTensor *_input; /**< Source tensor */
84  const ICLTensor *_indices; /**< Indices tensor */
85  ICLTensor *_output; /**< Destination tensor */
86  int _axis; /**< Axis index */
87 };
88 } // namespace arm_compute
89 #endif /*ARM_COMPUTE_CLGATHERKERNEL_H */
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
void run(const Window &window, cl::CommandQueue &queue) override
Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue...
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Interface for the kernel to perform tensor reshaping.
Common interface for all the OpenCL kernels.
Definition: ICLKernel.h:81
Copyright (c) 2017-2022 Arm Limited.
void configure(const ICLTensor *input, const ICLTensor *indices, ICLTensor *output, int axis=0)
Initialise the kernel&#39;s inputs and outputs.
static Status validate(const ITensorInfo *input, const ITensorInfo *indices, const ITensorInfo *output, int axis=0)
Static function to check if given info will lead to a valid configuration of CLGatherKernel.
CLCompileContext class.
~CLGatherKernel()=default
Default destructor.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
CLGatherKernel & operator=(const CLGatherKernel &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
Describe a multidimensional execution window.
Definition: Window.h:39
CLGatherKernel()
Default constructor.