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