1 /* 2 * Copyright (c) 2019-2022 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" 29 #include "arm_compute/runtime/NEON/INESimpleFunctionNoBorder.h" 30 31 namespace arm_compute 32 { 33 // Forward declarations 34 class ITensor; 35 class ITensorInfo; 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 * 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 3. Must be one of the following type: U32/S32. Each value Must be in range [0, input.shape[@p axis]) 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. 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 56 * 57 */ 58 void configure(const ITensor *input, const ITensor *indices, ITensor *output, int axis = 0); 59 60 /** Static function to check if given info will lead to a valid configuration 61 * 62 * Similar to @ref NEGather::configure() 63 * 64 * @return a status 65 */ 66 static Status validate(const ITensorInfo *input, const ITensorInfo *indices, const ITensorInfo *output, int axis); 67 }; 68 } // namespace arm_compute 69 70 #endif /* ARM_COMPUTE_NEGATHER_H */ 71