1 /* 2 * Copyright (c) 2018-2021 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_NEPERMUTE_H 25 #define ARM_COMPUTE_NEPERMUTE_H 26 27 #include "arm_compute/runtime/IFunction.h" 28 29 #include "arm_compute/core/Types.h" 30 31 #include <memory> 32 33 namespace arm_compute 34 { 35 // Forward declarations 36 class ITensor; 37 class ITensorInfo; 38 39 /** Basic function to run @ref cpu::kernels::CpuPermuteKernel */ 40 class NEPermute : public IFunction 41 { 42 public: 43 /** Default Constructor */ 44 NEPermute(); 45 /** Default Destructor */ 46 ~NEPermute(); 47 /** Prevent instances of this class from being copied (As this class contains pointers) */ 48 NEPermute(const NEPermute &) = delete; 49 /** Default move constructor */ 50 NEPermute(NEPermute &&) = default; 51 /** Prevent instances of this class from being copied (As this class contains pointers) */ 52 NEPermute &operator=(const NEPermute &) = delete; 53 /** Default move assignment operator */ 54 NEPermute &operator=(NEPermute &&) = default; 55 /** Configure the permute function 56 * 57 * Valid data layouts: 58 * - NHWC 59 * - NCHW 60 * 61 * Valid data type configurations: 62 * |src |dst | 63 * |:------|:------| 64 * |All |All | 65 * 66 * @note Arbitrary permutation vectors are supported with rank not greater than 4 67 * 68 * @param[in] input The input tensor to permute. Data types supported: All 69 * @param[out] output The output tensor. Data types supported: Same as @p input 70 * @param[in] perm Permutation vector 71 */ 72 void configure(const ITensor *input, ITensor *output, const PermutationVector &perm); 73 /** Static function to check if given info will lead to a valid configuration of @ref NEPermute 74 * 75 * @note Arbitrary permutation vectors are supported with rank not greater than 4 76 * 77 * @param[in] input The input tensor to permute. Data types supported: All 78 * @param[in] output The output tensor. Data types supported: Same as @p input 79 * @param[in] perm Permutation vector 80 * 81 * @return a status 82 */ 83 static Status validate(const ITensorInfo *input, const ITensorInfo *output, const PermutationVector &perm); 84 85 // Inherited methods overridden 86 void run() override; 87 88 private: 89 struct Impl; 90 std::unique_ptr<Impl> _impl; 91 }; 92 } // namespace arm_compute 93 #endif /* ARM_COMPUTE_NEPERMUTE_H */ 94