1 /* 2 * Copyright (c) 2017-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_NEIM2COL_H 25 #define ARM_COMPUTE_NEIM2COL_H 26 27 #include "arm_compute/runtime/NEON/INESimpleFunctionNoBorder.h" 28 29 #include "arm_compute/core/Size2D.h" 30 #include "arm_compute/core/Types.h" 31 #include <memory> 32 33 namespace arm_compute 34 { 35 // Forward declarations 36 class ITensor; 37 class ITensorInfo; 38 class NEIm2ColKernel; 39 40 /** Basic function to run @ref NEIm2ColKernel */ 41 class NEIm2Col : public IFunction 42 { 43 public: 44 /** Default constructor */ 45 NEIm2Col(); 46 /** Prevent instances of this class from being copied (As this class contains pointers) */ 47 NEIm2Col(const NEIm2Col &) = delete; 48 /** Prevent instances of this class from being copied (As this class contains pointers) */ 49 NEIm2Col &operator=(const NEIm2Col &) = delete; 50 /** Prevent instances of this class from being moved (As this class contains non movable objects) */ 51 NEIm2Col(NEIm2Col &&) = delete; 52 /** Prevent instances of this class from being moved (As this class contains non movable objects) */ 53 NEIm2Col &operator=(NEIm2Col &&) = delete; 54 /** Default destructor */ 55 ~NEIm2Col(); 56 /** Configure the im2col NEON kernel 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. 60 * Data types supported: QASYMM8/QASYMM8_SIGNED/BFLOAT16/F16/F32 61 * Note: QASYMM8/QASYMM8_SIGNED works only for has_bias = false 62 * @param[out] output The output tensor. Data types supported: Same as @p input 63 * @param[in] kernel_dims The kernel dimensions (width and height). 64 * @param[in] conv_info Contains padding and stride information described in @ref PadStrideInfo. 65 * @param[in] has_bias In case biases are provided expands the matrix with 1. 66 * @param[in] dilation (Optional) Dilation, in elements, across x and y. Defaults to (1, 1). 67 * @param[in] num_groups (Optional) Number of groups when performing a grouped convolution 68 */ 69 void configure(const ITensor *input, ITensor *output, const Size2D &kernel_dims, const PadStrideInfo &conv_info, bool has_bias, const Size2D &dilation = Size2D(1U, 1U), 70 unsigned int num_groups = 1); 71 /** Static function to check if given info will lead to a valid configuration of @ref NEIm2Col 72 * 73 * @param[in] input The input tensor to convert. 3 lower dimensions represent a single input [width, height, IFM], 74 * while every optional dimension from 4 and above represent a batch of inputs. 75 * Data types supported: QASYMM8/QASYMM8_SIGNED/BFLOAT16/F16/F32 76 * Note: QASYMM8/QASYMM8_SIGNED works only for has_bias = false 77 * @param[in] output The output tensor. Data types supported: Same as @p input 78 * @param[in] kernel_dims The kernel dimensions (width and height). 79 * @param[in] conv_info Contains padding and stride information described in @ref PadStrideInfo. 80 * @param[in] has_bias In case biases are provided expands the matrix with 1. 81 * @param[in] dilation (Optional) Dilation, in elements, across x and y. Defaults to (1, 1). 82 * @param[in] num_groups (Optional) Number of groups when performing a grouped convolution 83 * 84 * @return a status 85 */ 86 static Status validate(const ITensorInfo *input, const ITensorInfo *output, const Size2D &kernel_dims, const PadStrideInfo &conv_info, bool has_bias, const Size2D &dilation = Size2D(1U, 1U), 87 unsigned int num_groups = 1); 88 89 // Inherited methods overridden: 90 void run() override; 91 92 private: 93 std::unique_ptr<NEIm2ColKernel> _kernel; 94 unsigned int _y_dim; 95 }; 96 } // namespace arm_compute 97 #endif /* ARM_COMPUTE_NEIM2COL_H */ 98