Compute Library
 21.02
NEGather.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019-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 
25 #ifndef ARM_COMPUTE_NEGATHER_H
26 #define ARM_COMPUTE_NEGATHER_H
27 
28 #include "arm_compute/core/Types.h"
30 
31 namespace arm_compute
32 {
33 // Forward declarations
34 class ITensor;
35 class ITensorInfo;
36 
37 /** Basic function to run @ref NEGatherKernel */
39 {
40 public:
41  /** Initialise the kernel's inputs and outputs
42  *
43  * @param[in] input Source tensor. Supported tensor rank: up to 4. Data type supported: All
44  * @param[in] indices Indices tensor. Supported tensor rank: up to 1. Must be one of the following type: U32/S32. Each value Must be in range [0, input.shape[@p axis])
45  * @param[out] output Destination tensor. Data type supported: Same as @p input
46  * @param[in] axis (Optional) The axis in @p input to gather @p indices from. Defaults to 0
47  */
48  void configure(const ITensor *input, const ITensor *indices, ITensor *output, int axis = 0);
49 
50  /** Static function to check if given info will lead to a valid configuration of @ref NEGatherKernel
51  *
52  * @param[in] input Source tensor info. Supported tensor rank: up to 4. Data type supported: All
53  * @param[in] indices Indices tensor info. 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[in] output Destination tensor info. Data type supported: Same as @p input
55  * @param[in] axis (Optional) The axis in @p input to gather @p indices from. Defaults to 0
56  *
57  * @return a status
58  */
59  static Status validate(const ITensorInfo *input, const ITensorInfo *indices, const ITensorInfo *output, int axis);
60 };
61 } // namespace arm_compute
62 
63 #endif /* ARM_COMPUTE_NEGATHER_H */
static Status validate(const ITensorInfo *input, const ITensorInfo *indices, const ITensorInfo *output, int axis)
Static function to check if given info will lead to a valid configuration of NEGatherKernel.
Definition: NEGather.cpp:39
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Interface for Neon tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2021 Arm Limited.
Basic interface for functions which have a single Neon kernel and no border.
Basic function to run NEGatherKernel.
Definition: NEGather.h:38
void configure(const ITensor *input, const ITensor *indices, ITensor *output, int axis=0)
Initialise the kernel's inputs and outputs.
Definition: NEGather.cpp:32