John Kesapides | 2dce6cc | 2019-01-14 09:47:09 +0000 | [diff] [blame] | 1 | /* |
Viet-Hoa Do | a25582c | 2023-03-15 16:52:05 +0000 | [diff] [blame] | 2 | * Copyright (c) 2019-2023 Arm Limited. |
John Kesapides | 2dce6cc | 2019-01-14 09:47:09 +0000 | [diff] [blame] | 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 | |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 25 | #ifndef ARM_COMPUTE_NEGATHER_H |
| 26 | #define ARM_COMPUTE_NEGATHER_H |
John Kesapides | 2dce6cc | 2019-01-14 09:47:09 +0000 | [diff] [blame] | 27 | |
| 28 | #include "arm_compute/core/Types.h" |
| 29 | #include "arm_compute/runtime/NEON/INESimpleFunctionNoBorder.h" |
| 30 | |
| 31 | namespace arm_compute |
| 32 | { |
Georgios Pinitas | 3384356 | 2019-12-10 13:33:18 +0000 | [diff] [blame] | 33 | // Forward declarations |
John Kesapides | 2dce6cc | 2019-01-14 09:47:09 +0000 | [diff] [blame] | 34 | class ITensor; |
Michalis Spyrou | ebcebf1 | 2020-10-21 00:04:14 +0100 | [diff] [blame] | 35 | class ITensorInfo; |
John Kesapides | 2dce6cc | 2019-01-14 09:47:09 +0000 | [diff] [blame] | 36 | |
| 37 | /** Basic function to run @ref NEGatherKernel */ |
| 38 | class NEGather : public INESimpleFunctionNoBorder |
| 39 | { |
| 40 | public: |
| 41 | /** Initialise the kernel's inputs and outputs |
| 42 | * |
Teresa Charlin | 6268742 | 2021-04-28 10:58:49 +0100 | [diff] [blame] | 43 | * Valid data layouts: |
| 44 | * - All |
| 45 | * |
| 46 | * Valid data type configurations: |
| 47 | * |src |dst | |
| 48 | * |:--------------|:--------------| |
| 49 | * |All |All | |
| 50 | * |
Georgios Pinitas | 3384356 | 2019-12-10 13:33:18 +0000 | [diff] [blame] | 51 | * @param[in] input Source tensor. Supported tensor rank: up to 4. Data type supported: All |
Viet-Hoa Do | a25582c | 2023-03-15 16:52:05 +0000 | [diff] [blame] | 52 | * @param[in] indices Indices tensor. Supported tensor rank: up to 3. Must be one of the following type: U32/S32. Each value must be in range [0, input.shape[@p axis]), otherwise the result will become unpredictable. |
Pablo Marquez Tello | 894659a | 2022-05-13 12:20:16 +0100 | [diff] [blame] | 53 | * @note The "axis" must be in the range [0, input.rank -1] when indices is a vector, and must be 1 when indices is a 2D or 3D tensor. |
John Kesapides | 2dce6cc | 2019-01-14 09:47:09 +0000 | [diff] [blame] | 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. Defaults to 0 |
Pablo Marquez Tello | 894659a | 2022-05-13 12:20:16 +0100 | [diff] [blame] | 56 | * |
John Kesapides | 2dce6cc | 2019-01-14 09:47:09 +0000 | [diff] [blame] | 57 | */ |
| 58 | void configure(const ITensor *input, const ITensor *indices, ITensor *output, int axis = 0); |
| 59 | |
Pablo Marquez Tello | 894659a | 2022-05-13 12:20:16 +0100 | [diff] [blame] | 60 | /** Static function to check if given info will lead to a valid configuration |
John Kesapides | 2dce6cc | 2019-01-14 09:47:09 +0000 | [diff] [blame] | 61 | * |
Pablo Marquez Tello | 894659a | 2022-05-13 12:20:16 +0100 | [diff] [blame] | 62 | * Similar to @ref NEGather::configure() |
John Kesapides | 2dce6cc | 2019-01-14 09:47:09 +0000 | [diff] [blame] | 63 | * |
| 64 | * @return a status |
| 65 | */ |
| 66 | static Status validate(const ITensorInfo *input, const ITensorInfo *indices, const ITensorInfo *output, int axis); |
| 67 | }; |
John Kesapides | 2dce6cc | 2019-01-14 09:47:09 +0000 | [diff] [blame] | 68 | } // namespace arm_compute |
| 69 | |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 70 | #endif /* ARM_COMPUTE_NEGATHER_H */ |