arm_compute/runtime/NEON/functions/NEIm2Col.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_NEIM2COL_H__
  25 #define __ARM_COMPUTE_NEIM2COL_H__
  26
  27 #include "arm_compute/runtime/NEON/INESimpleFunction.h"
  28
  29 #include "arm_compute/core/NEON/kernels/NEIm2ColKernel.h"
  30 #include "arm_compute/core/Size2D.h"
  31 #include "arm_compute/core/Types.h"
  32
  33 namespace arm_compute
  34 {
  35 class ITensor;
  36
  37 /** Basic function to run @ref NEIm2ColKernel */
  38 class NEIm2Col : public IFunction
  39 {
  40 public:
  41     /** Default constructor */
  42     NEIm2Col();
  43     /** Configure the im2col NEON kernel
  44      *
  45      * @param[in]  input              The input tensor to convert. 3 lower dimensions represent a single input [width, height, IFM],
  46      *                                while every optional dimension from 4 and above represent a batch of inputs. Data types supported: QS8/QS16/QASYMM8/F16/F32
  47      *                                Note: QASYMM8 works only for has_bias = false
  48      * @param[out] output             The output tensor. Data types supported: Same as @p input
  49      * @param[in]  kernel_dims        The kernel dimensions (width and height).
  50      * @param[in]  conv_info          Contains padding and stride information described in @ref PadStrideInfo.
  51      * @param[in]  has_bias           In case biases are provided expands the matrix with 1.
  52      * @param[in]  is_fully_connected (Optional) Determines whether this function will be called by @ref NEFullyConnectedLayer in order to validate the arguments
  53      * @param[in]  is_flatten         (Optional) Determines whether this function will be called by @ref NEFlattenLayer in order to validate the arguments
  54      */
  55     void configure(const ITensor *input, ITensor *output, const Size2D &kernel_dims, const PadStrideInfo &conv_info, bool has_bias, bool is_fully_connected = false, bool is_flatten = false);
  56     /** Static function to check if given info will lead to a valid configuration of @ref NEIm2Col
  57      *
  58      * @param[in] input              The input tensor to convert. 3 lower dimensions represent a single input [width, height, IFM],
  59      *                               while every optional dimension from 4 and above represent a batch of inputs. Data types supported: QS8/QS16/QASYMM8/F16/F32
  60      *                               Note: QASYMM8 works only for has_bias = false
  61      * @param[in] output             The output tensor. Data types supported: Same as @p input
  62      * @param[in] kernel_dims        The kernel dimensions (width and height).
  63      * @param[in] conv_info          Contains padding and stride information described in @ref PadStrideInfo.
  64      * @param[in] has_bias           In case biases are provided expands the matrix with 1.
  65      * @param[in] is_fully_connected Determines whether this function will be called by @ref NEFullyConnectedLayer in order to validate the arguments
  66      * @param[in] is_flatten         Determines whether this function will be called by @ref NEFlattenLayer in order to validate the arguments
  67      *
  68      * @return a status
  69      */
  70     static Status validate(const ITensorInfo *input, const ITensorInfo *output, const Size2D &kernel_dims, const PadStrideInfo &conv_info, bool has_bias, bool is_fully_connected, bool is_flatten);
  71
  72     // Inherited methods overridden:
  73     void run() override;
  74
  75 private:
  76     NEIm2ColKernel _kernel;
  77     unsigned int   _y_dim;
  78 };
  79 }
  80 #endif /* __ARM_COMPUTE_NEIM2COL_H__ */