1 /* 2 * Copyright (c) 2018-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 #ifndef ARM_COMPUTE_NEPERMUTEKERNEL_H 25 #define ARM_COMPUTE_NEPERMUTEKERNEL_H 26 27 #include "src/core/NEON/INEKernel.h" 28 29 namespace arm_compute 30 { 31 // Forward declarations 32 class ITensor; 33 34 /** NEON kernel to perform tensor permutation. 35 * 36 * Permutes given a permutation vector 37 */ 38 class NEPermuteKernel : public INEKernel 39 { 40 public: name()41 const char *name() const override 42 { 43 return "NEPermuteKernel"; 44 } 45 /** Default constructor */ 46 NEPermuteKernel(); 47 /** Prevent instances of this class from being copied (As this class contains pointers) */ 48 NEPermuteKernel(const NEPermuteKernel &) = delete; 49 /** Prevent instances of this class from being copied (As this class contains pointers) */ 50 NEPermuteKernel &operator=(const NEPermuteKernel &) = delete; 51 /** Allow instances of this class to be moved */ 52 NEPermuteKernel(NEPermuteKernel &&) = default; 53 /** Allow instances of this class to be moved */ 54 NEPermuteKernel &operator=(NEPermuteKernel &&) = default; 55 /** Default destructor */ 56 ~NEPermuteKernel() = default; 57 58 /** Set the input and output of the kernel. 59 * 60 * @note Arbitrary permutation vectors are supported with rank not greater than 4 61 * 62 * @param[in] input The input tensor to permute. Data types supported: All 63 * @param[out] output The output tensor. Data types supported: Same as @p input 64 * @param[in] perm Permutation vector 65 */ 66 void configure(const ITensor *input, ITensor *output, const PermutationVector &perm); 67 /** Static function to check if given info will lead to a valid configuration of @ref CPPPermuteKernel 68 * 69 * @note Arbitrary permutation vectors are supported with rank not greater than 4 70 * 71 * @param[in] input The input tensor to permute. Data types supported: All 72 * @param[in] output The output tensor. Data types supported: Same as @p input 73 * @param[in] perm Permutation vector 74 * 75 * @return a status 76 */ 77 static Status validate(const ITensorInfo *input, const ITensorInfo *output, const PermutationVector &perm); 78 79 // Inherited methods overridden: 80 void run(const Window &window, const ThreadInfo &info) override; 81 82 private: 83 /** Template function to run the permute 84 * 85 * @param[in] window Region on which to execute the kernel. (Must be a valid region of the window returned by window()). 86 */ 87 template <typename T> 88 void run_permute(const Window &window); 89 90 /** Common signature for all the specialised permute functions 91 * 92 * @param[in] window Region on which to execute the kernel. 93 */ 94 using PermuteFunctionPtr = void (NEPermuteKernel::*)(const Window &window); 95 96 PermuteFunctionPtr _func; 97 const ITensor *_input; 98 ITensor *_output; 99 PermutationVector _perm; 100 }; 101 } // namespace arm_compute 102 #endif /*ARM_COMPUTE_NEPERMUTEKERNEL_H */ 103