arm_compute/core/CL/kernels/CLDepthwiseWeightsReshapeKernel.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_CLDEPTHWISEWEIGHTSRESHAPEKERNEL_H__
  25 #define __ARM_COMPUTE_CLDEPTHWISEWEIGHTSRESHAPEKERNEL_H__
  26
  27 #include "arm_compute/core/CL/ICLKernel.h"
  28
  29 namespace arm_compute
  30 {
  31 class ICLTensor;
  32
  33 /** Interface for the depthwise weights reshape kernel.
  34  *  This kernel reshape original weights' low 2D dimensions into a single row and
  35  *  have the second dimension as the original depth size.
  36  *
  37  **/
  38 class CLDepthwiseWeightsReshapeKernel : public ICLKernel
  39 {
  40 public:
  41     /** Default constructor */
  42     CLDepthwiseWeightsReshapeKernel();
  43     /** Prevent instances of this class from being copied (As this class contains pointers) */
  44     CLDepthwiseWeightsReshapeKernel(const CLDepthwiseWeightsReshapeKernel &) = delete;
  45     /** Prevent instances of this class from being copied (As this class contains pointers) */
  46     CLDepthwiseWeightsReshapeKernel &operator=(const CLDepthwiseWeightsReshapeKernel &) = delete;
  47     /** Allow instances of this class to be moved */
  48     CLDepthwiseWeightsReshapeKernel(CLDepthwiseWeightsReshapeKernel &&) = default;
  49     /** Allow instances of this class to be moved */
  50     CLDepthwiseWeightsReshapeKernel &operator=(CLDepthwiseWeightsReshapeKernel &&) = default;
  51     /** Set the input and output of the kernel.
  52      *
  53      * @param[in]  input  The input tensor to convert. 3 lower dimensions represent a single input [width, height, IFM].
  54      *                    Data type supported: QASYMM8/F16/F32.
  55      * @param[out] output The output tensor. Data type supported: same as @p input.
  56      * @param[in]  biases (Optional) The input biases to add. Shape [IFM]. Data type supported: same as @p input.
  57      */
  58     void configure(const ICLTensor *input, ICLTensor *output, const ICLTensor *biases = nullptr);
  59     /** Static function to check if given info will lead to a valid configuration of @ref CLDepthwiseWeightsReshapeKernel
  60      *
  61      * @param[in] input  The input tensor to convert. 3 lower dimensions represent a single input [width, height, IFM].
  62      *                   Data type supported: QASYMM8/F32.
  63      * @param[in] output The output tensor. Data type supported: same as @p input.
  64      * @param[in] biases (Optional) The input biases to add. Shape [IFM]. Data type supported: same as @p input.
  65      *
  66      * @return a status
  67      */
  68     static Status validate(const ITensorInfo *input, const ITensorInfo *output, const ITensorInfo *biases = nullptr);
  69
  70     // Inherited methods overridden:
  71     void run(const Window &window, cl::CommandQueue &queue) override;
  72
  73 private:
  74     const ICLTensor *_input;
  75     const ICLTensor *_biases;
  76     ICLTensor       *_output;
  77 };
  78 } // arm_compute
  79 #endif /*__ARM_COMPUTE_CLDEPTHWISEWEIGHTSRESHAPEKERNEL_H__ */