Compute Library
 22.05
CLGather.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018-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 
25 #ifndef ARM_COMPUTE_CLGATHER_H
26 #define ARM_COMPUTE_CLGATHER_H
27 
28 #include "arm_compute/core/Error.h"
30 
31 namespace arm_compute
32 {
33 class CLCompileContext;
34 class ICLTensor;
35 class ITensorInfo;
36 
37 /** Basic function to run @ref CLGatherKernel */
39 {
40 public:
41  /** Initialise the kernel's inputs and outputs
42  *
43  * Valid data layouts:
44  * - All
45  *
46  * Valid data type configurations:
47  * |src |dst |
48  * |:--------------|:--------------|
49  * |All |All |
50  *
51  * @param[in] input Source tensor. Supported tensor rank: up to 4. Data type supported: All.
52  * @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])
53  * @param[out] output Destination tensor. Data type supported: Same as @p input
54  * @param[in] axis (Optional) The axis in @p input to gather @p indices from. Defaults to 0
55  */
56  void configure(const ICLTensor *input, const ICLTensor *indices, ICLTensor *output, int axis = 0);
57  /** Initialise the kernel's inputs and outputs
58  *
59  * @param[in] compile_context The compile context to be used.
60  * @param[in] input Source tensor. Supported tensor rank: up to 4. Data type supported: All.
61  * @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])
62  * @param[out] output Destination tensor. Data type supported: Same as @p input
63  * @param[in] axis (Optional) The axis in @p input to gather @p indices from. Defaults to 0
64  */
65  void configure(const CLCompileContext &compile_context, const ICLTensor *input, const ICLTensor *indices, ICLTensor *output, int axis = 0);
66 
67  /** Static function to check if given info will lead to a valid configuration of @ref CLGatherKernel
68  *
69  * @param[in] input Source tensor info. Supported tensor rank: up to 4. Data type supported: All.
70  * @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])
71  * @param[in] output Destination tensor info. Data type supported: Same as @p input
72  * @param[in] axis (Optional) The axis in @p input to gather @p indices from. Defaults to 0
73  *
74  * @return a status
75  */
76  static Status validate(const ITensorInfo *input, const ITensorInfo *indices, const ITensorInfo *output, int axis = 0);
77 };
78 } // namespace arm_compute
79 #endif /* ARM_COMPUTE_CLGATHER_H */
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.
Definition: CLGather.cpp:46
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Copyright (c) 2017-2022 Arm Limited.
Basic interface for functions which have a single OpenCL kernel.
void configure(const ICLTensor *input, const ICLTensor *indices, ICLTensor *output, int axis=0)
Initialise the kernel's inputs and outputs.
Definition: CLGather.cpp:33
CLCompileContext class.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
Basic function to run CLGatherKernel.
Definition: CLGather.h:38