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_CLPERMUTEKERNEL_H 25 #define ARM_COMPUTE_CLPERMUTEKERNEL_H 26 27 #include "src/core/CL/ICLKernel.h" 28 29 namespace arm_compute 30 { 31 class ICLTensor; 32 33 /** OpenCL kernel to perform tensor permutation. 34 * 35 * Permutes given a permutation vector 36 */ 37 class CLPermuteKernel : public ICLKernel 38 { 39 public: 40 /** Default constructor */ 41 CLPermuteKernel(); 42 /** Prevent instances of this class from being copied (As this class contains pointers) */ 43 CLPermuteKernel(const CLPermuteKernel &) = delete; 44 /** Prevent instances of this class from being copied (As this class contains pointers) */ 45 CLPermuteKernel &operator=(const CLPermuteKernel &) = delete; 46 /** Allow instances of this class to be moved */ 47 CLPermuteKernel(CLPermuteKernel &&) = default; 48 /** Allow instances of this class to be moved */ 49 CLPermuteKernel &operator=(CLPermuteKernel &&) = default; 50 /** Set the input and output of the kernel. 51 * 52 * @note Arbitrary permutation vectors are supported with rank not greater than 4 53 * 54 * @param[in] input The input tensor to permute. Data types supported: All. 55 * @param[in] output The output tensor. Data types supported: Same as @p input 56 * @param[in] perm Permutation vector 57 */ 58 void configure(const ICLTensor *input, ICLTensor *output, const PermutationVector &perm); 59 /** Set the input and output of the kernel. 60 * 61 * @note Arbitrary permutation vectors are supported with rank not greater than 4 62 * 63 * @param[in] compile_context The compile context to be used. 64 * @param[in] input The input tensor to permute. Data types supported: All. 65 * @param[in] output The output tensor. Data types supported: Same as @p input 66 * @param[in] perm Permutation vector 67 */ 68 void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, const PermutationVector &perm); 69 /** Static function to check if given info will lead to a valid configuration of @ref CLPermuteKernel 70 * 71 * @note Arbitrary permutation vectors are supported with rank not greater than 4 72 * 73 * @param[in] input First tensor input info. Data types supported: All. 74 * @param[in] output Output tensor info. Data types supported: same as @p input. 75 * @param[in] perm Permutation vector 76 * 77 * @return a status 78 */ 79 static Status validate(const ITensorInfo *input, const ITensorInfo *output, const PermutationVector &perm); 80 81 // Inherited methods overridden: 82 void run(const Window &window, cl::CommandQueue &queue) override; 83 84 private: 85 const ICLTensor *_input; 86 ICLTensor *_output; 87 PermutationVector _perm; 88 }; 89 } // arm_compute 90 #endif /*ARM_COMPUTE_CLPERMUTEKERNEL_H */ 91