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_NEGATHERKERNEL_H 26 #define ARM_COMPUTE_NEGATHERKERNEL_H 27 28 #include "arm_compute/core/Types.h" 29 #include "src/core/NEON/INEKernel.h" 30 31 namespace arm_compute 32 { 33 // Forward declarations 34 class ITensor; 35 36 /** Kernel to perform other operation on NEON */ 37 class NEGatherKernel : public INEKernel 38 { 39 public: 40 /** Default constructor. */ 41 NEGatherKernel(); 42 /** Prevent instances of this class from being copied (As this class contains pointers). */ 43 NEGatherKernel(const NEGatherKernel &) = delete; 44 /** Prevent instances of this class from being copied (As this class contains pointers). */ 45 NEGatherKernel &operator=(const NEGatherKernel &) = delete; 46 /** Allow instances of this class to be moved. */ 47 NEGatherKernel(NEGatherKernel &&) = default; 48 /** Allow instances of this class to be moved. */ 49 NEGatherKernel &operator=(NEGatherKernel &&) = default; 50 /** Default detructor */ 51 ~NEGatherKernel() = default; 52 53 /** Name of the kernel 54 * 55 * @return Kernel name 56 */ name()57 const char *name() const override 58 { 59 return "NEGatherKernel"; 60 } 61 /** Initialise the kernel's inputs and outputs 62 * 63 * @param[in] input Source tensor. Supported tensor rank: up to 4. Data type supported: All 64 * @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]) 65 * @param[out] output Destination tensor. Data type supported: Same as @p input 66 * @param[in] axis (Optional) The axis in @p input to gather @p indices from. Negative values wrap around. Defaults to 0 67 */ 68 void configure(const ITensor *input, const ITensor *indices, ITensor *output, int axis = 0); 69 /** Static function to check if given info will lead to a valid configuration of @ref NEGatherKernel 70 * 71 * @param[in] input Source tensor info. Supported tensor rank: up to 4. Data type supported: All 72 * @param[in] indices Indices tensor info. 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]) 73 * @param[in] output Destination tensor info. Data type supported: Same as @p input 74 * @param[in] axis (Optional) The axis in @p input to gather @p indices from. Negative values wrap around. Defaults to 0 75 * 76 * @return a status 77 */ 78 static Status validate(const ITensorInfo *input, const ITensorInfo *indices, const ITensorInfo *output, int axis); 79 80 // Inherited methods overridden: 81 void run(const Window &window, const ThreadInfo &info) override; 82 83 private: 84 /** Implementation of the gather operation for 0 axis. 85 * 86 * For gather on the 0 axis an element by element copy is performed. 87 * 88 * @param[in] window Region on which to execute the kernel. (Must be a region of the window returned by window()) 89 * @param[in] info Info about executing thread and CPU. 90 */ 91 template <typename U> 92 void gather_0_axis(const Window &window, const ThreadInfo &info); 93 94 /** Implementation of the gather operation. 95 * 96 * For 1<=axis a row-wise copy is taking place. 97 * 98 * @param[in] window Region on which to execute the kernel. (Must be a region of the window returned by window()) 99 * @param[in] info Info about executing thread and CPU. 100 */ 101 template <typename U> 102 void gather_n_axis(const Window &window, const ThreadInfo &info); 103 104 using kernel_ptr = void (NEGatherKernel::*)(const Window &window, const ThreadInfo &info); 105 106 const ITensor *_input; 107 const ITensor *_indices; 108 int _axis; 109 ITensor *_output; 110 kernel_ptr _func; 111 }; 112 } // namespace arm_compute 113 #endif /* ARM_COMPUTE_NEGATHERKERNEL_H */ 114