arm_compute/core/NEON/kernels/NETransposeKernel.h

   1 /*
   2  * Copyright (c) 2017-2018 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_NETRANSPOSEKERNEL_H__
  25 #define __ARM_COMPUTE_NETRANSPOSEKERNEL_H__
  26
  27 #include "arm_compute/core/NEON/INEKernel.h"
  28
  29 namespace arm_compute
  30 {
  31 class ITensor;
  32
  33 /** NEON kernel which transposes the elements of a matrix.
  34  *
  35  * [width, height, batch] -> [height, width, batch]
  36  *
  37  */
  38 class NETransposeKernel : public INEKernel
  39 {
  40 public:
  41     const char *name() const override
  42     {
  43         return "NETransposeKernel";
  44     }
  45     /** Default constructor */
  46     NETransposeKernel();
  47     /** Prevent instances of this class from being copied (As this class contains pointers) */
  48     NETransposeKernel(const NETransposeKernel &) = delete;
  49     /** Prevent instances of this class from being copied (As this class contains pointers) */
  50     NETransposeKernel &operator=(const NETransposeKernel &) = delete;
  51     /** Allow instances of this class to be moved */
  52     NETransposeKernel(NETransposeKernel &&) = default;
  53     /** Allow instances of this class to be moved */
  54     NETransposeKernel &operator=(NETransposeKernel &&) = default;
  55     /** Default destructor */
  56     ~NETransposeKernel() = default;
  57
  58     /** Initialise the kernel's input and output.
  59      *
  60      * @param[in]  input  Input tensor. Data types supported: U8/S8/QS8/QASYMM8/U16/S16/QS16/F16/U32/S32/F32
  61      * @param[out] output Output tensor. Data type supported: Same as @p input
  62      */
  63     void configure(const ITensor *input, ITensor *output);
  64     /** Static function to check if given info will lead to a valid configuration of @ref NETransposeKernel
  65      *
  66      * @param[in] input  Input tensor. Data types supported: U8/S8/QS8/QASYMM8/U16/S16/QS16/F16/U32/S32/F32
  67      * @param[in] output Output tensor. Data type supported: Same as @p input
  68      *
  69      * @return a status
  70      */
  71     static Status validate(const ITensorInfo *input, const ITensorInfo *output);
  72
  73     // Inherited methods overridden:
  74     void run(const Window &window, const ThreadInfo &info) override;
  75
  76 private:
  77     /** Common signature for all the transpose functions
  78      *
  79      * @param[in]  input  An input tensor. Data types supported: U8/S8/QS8/U16/S16/QS16/F16/U32/S32/F32
  80      * @param[out] output The output tensor. Data type supported: same as @p input
  81      * @param[in]  window Region on which to execute the kernel.
  82      */
  83     using TransposeFunction = void(const ITensor *input, ITensor *output, const Window &window);
  84     /** Transpose function to use for the particular tensor types passed to configure() */
  85     TransposeFunction *_func;
  86     const ITensor     *_input;
  87     ITensor           *_output;
  88 };
  89 } // namespace arm_compute
  90 #endif /* __ARM_COMPUTE_NETRANSPOSEKERNEL_H__ */