Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 1 | /* |
Gian Marco Iodice | feaea10 | 2020-09-03 13:20:34 +0100 | [diff] [blame] | 2 | * Copyright (c) 2016-2020 Arm Limited. |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 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 | */ |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 24 | #ifndef ARM_COMPUTE_NEGEMMINTERLEAVE4x4KERNEL_H |
| 25 | #define ARM_COMPUTE_NEGEMMINTERLEAVE4x4KERNEL_H |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 26 | |
Michalis Spyrou | ebcebf1 | 2020-10-21 00:04:14 +0100 | [diff] [blame] | 27 | #include "src/core/NEON/INESimpleKernel.h" |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 28 | |
| 29 | namespace arm_compute |
| 30 | { |
| 31 | class ITensor; |
| 32 | |
| 33 | /** NEON kernel to interleave the elements of a matrix |
| 34 | * |
| 35 | * This function puts the values in a 4x4 block of Matrix A on the same row (Interleaved values) |
| 36 | * |
| 37 | * @f[ |
| 38 | * \left( \begin{array}{cccc} |
| 39 | * a00 & a01 & a02 & a03 \\ |
| 40 | * a10 & a11 & a12 & a13 \\ |
| 41 | * a20 & a21 & a22 & a23 \\ |
| 42 | * a30 & a31 & a32 & a33 \\ |
| 43 | * \end{array} \right) |
| 44 | * \rightarrow |
| 45 | * \left( \begin{array}{ccccccccccccccccc} |
| 46 | * a00 & a10 & a20 & a30 & a01 & a11 & a21 & a31 & a02 & a12 & a22 & a32 & a03 & a13 & a23 & a33 \\ |
| 47 | * \end{array} \right) |
| 48 | * @f] |
| 49 | * |
| 50 | * After this operation, the output matrix will have the following shape: [ height * 4, ceil(width / 4.0f) ] |
| 51 | */ |
| 52 | class NEGEMMInterleave4x4Kernel : public INESimpleKernel |
| 53 | { |
| 54 | public: |
Anthony Barbier | e8a4983 | 2018-01-18 10:04:05 +0000 | [diff] [blame] | 55 | const char *name() const override |
| 56 | { |
| 57 | return "NEGEMMInterleave4x4Kernel"; |
| 58 | } |
Michalis Spyrou | ebcebf1 | 2020-10-21 00:04:14 +0100 | [diff] [blame] | 59 | /** Constructor */ |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 60 | NEGEMMInterleave4x4Kernel(); |
Michalis Spyrou | ebcebf1 | 2020-10-21 00:04:14 +0100 | [diff] [blame] | 61 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 62 | NEGEMMInterleave4x4Kernel(const NEGEMMInterleave4x4Kernel &) = delete; |
| 63 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 64 | NEGEMMInterleave4x4Kernel &operator=(const NEGEMMInterleave4x4Kernel &) = delete; |
| 65 | /** Allow instances of this class to be moved */ |
| 66 | NEGEMMInterleave4x4Kernel(NEGEMMInterleave4x4Kernel &&) = default; |
| 67 | /** Allow instances of this class to be moved */ |
| 68 | NEGEMMInterleave4x4Kernel &operator=(NEGEMMInterleave4x4Kernel &&) = default; |
| 69 | /** Default destructor */ |
| 70 | ~NEGEMMInterleave4x4Kernel() = default; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 71 | /** Initialise the kernel's input and output. |
| 72 | * |
Georgios Pinitas | dbdea0d | 2019-10-16 19:21:40 +0100 | [diff] [blame] | 73 | * @param[in] input Input tensor. Data types supported: All |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 74 | * @param[out] output Output tensor which stores the interleaved matrix. Data type supported: same as @p input. |
| 75 | */ |
| 76 | void configure(const ITensor *input, ITensor *output); |
Georgios Pinitas | a3b1b46 | 2017-11-16 19:24:39 +0000 | [diff] [blame] | 77 | /** Static function to check if given info will lead to a valid configuration of @ref NEGEMMInterleave4x4Kernel |
| 78 | * |
Georgios Pinitas | dbdea0d | 2019-10-16 19:21:40 +0100 | [diff] [blame] | 79 | * @param[in] input Input tensor info. Data types supported: All |
Georgios Pinitas | a3b1b46 | 2017-11-16 19:24:39 +0000 | [diff] [blame] | 80 | * @param[in] output Output tensor info which stores the interleaved matrix. Data type supported: same as @p input. |
| 81 | * |
Georgios Pinitas | 631c41a | 2017-12-06 11:53:03 +0000 | [diff] [blame] | 82 | * @return a status |
Georgios Pinitas | a3b1b46 | 2017-11-16 19:24:39 +0000 | [diff] [blame] | 83 | */ |
Georgios Pinitas | 631c41a | 2017-12-06 11:53:03 +0000 | [diff] [blame] | 84 | static Status validate(const ITensorInfo *input, const ITensorInfo *output); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 85 | |
| 86 | // Inherited methods overridden: |
Moritz Pflanzer | c186b57 | 2017-09-07 09:48:04 +0100 | [diff] [blame] | 87 | void run(const Window &window, const ThreadInfo &info) override; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 88 | |
| 89 | private: |
Gian Marco Iodice | feaea10 | 2020-09-03 13:20:34 +0100 | [diff] [blame] | 90 | /** Template function to run gemm interleave 4x4 |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 91 | * |
Gian Marco Iodice | feaea10 | 2020-09-03 13:20:34 +0100 | [diff] [blame] | 92 | * @tparam ScalarType Scalar datatype |
| 93 | * |
| 94 | * @param[in] input Input tensor. Data types supported: uint32_t, uint16_t and uint8_t |
| 95 | * @param[out] output Output tensor. Data types supported: uint32_t, uint16_t and uint8_t |
| 96 | * @param[in] window Region on which to execute the kernel. (Must be a valid region of the window returned by window()). |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 97 | */ |
Gian Marco Iodice | feaea10 | 2020-09-03 13:20:34 +0100 | [diff] [blame] | 98 | template <typename ScalarType> |
| 99 | void gemm_interleave4x4(const ITensor *input, ITensor *output, const Window &window); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 100 | |
Gian Marco Iodice | feaea10 | 2020-09-03 13:20:34 +0100 | [diff] [blame] | 101 | /** Common signature for all the specialised gemm interleave 4x4 functions |
| 102 | * |
| 103 | * @param[in] input Input tensor. Data types supported: uint32_t, uint16_t and uint8_t |
| 104 | * @param[out] output Output tensor. Data types supported: uint32_t, uint16_t and uint8_t |
| 105 | * @param[in] window Region on which to execute the kernel. (Must be a valid region of the window returned by window()). |
| 106 | */ |
| 107 | using GEMMInterleaveFunctionFuncPtr = void (NEGEMMInterleave4x4Kernel::*)(const ITensor *input, ITensor *output, const Window &window); |
| 108 | |
| 109 | GEMMInterleaveFunctionFuncPtr _func; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 110 | }; |
Gian Marco Iodice | 356f643 | 2017-09-22 11:32:21 +0100 | [diff] [blame] | 111 | } // namespace arm_compute |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 112 | #endif /*ARM_COMPUTE_NEGEMMINTERLEAVE4x4KERNEL_H*/ |