arm_compute/core/CL/kernels/CLDeconvolutionLayerUpsampleKernel.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_CLDECONVOLUTIONLAYERUPSAMPLEKERNEL_H__
  25 #define __ARM_COMPUTE_CLDECONVOLUTIONLAYERUPSAMPLEKERNEL_H__
  26
  27 #include "arm_compute/core/CL/ICLKernel.h"
  28
  29 namespace arm_compute
  30 {
  31 class ICLTensor;
  32
  33 /** Interface for the Deconvolution layer kernel on OpenCL.
  34  */
  35 class CLDeconvolutionLayerUpsampleKernel : public ICLKernel
  36 {
  37 public:
  38     /** Constructor */
  39     CLDeconvolutionLayerUpsampleKernel();
  40     /** Prevent instances of this class from being copied (As this class contains pointers) */
  41     CLDeconvolutionLayerUpsampleKernel(const CLDeconvolutionLayerUpsampleKernel &) = delete;
  42     /** Prevent instances of this class from being copied (As this class contains pointers) */
  43     CLDeconvolutionLayerUpsampleKernel &operator=(const CLDeconvolutionLayerUpsampleKernel &) = delete;
  44     /** Default Move Constructor. */
  45     CLDeconvolutionLayerUpsampleKernel(CLDeconvolutionLayerUpsampleKernel &&) = default;
  46     /** Default move assignment operator */
  47     CLDeconvolutionLayerUpsampleKernel &operator=(CLDeconvolutionLayerUpsampleKernel &&) = default;
  48     /** Default destructor */
  49     ~CLDeconvolutionLayerUpsampleKernel() = default;
  50
  51     /** Initialise the kernel's input and output.
  52      *
  53      * @param[in]  input        Source tensor. Data types supported: F32.
  54      * @param[out] output       Destination tensor. Data types supported: F32. All but the lowest two dimensions must be the same size as in the input tensor, i.e. scaling is only performed within the XY-plane.
  55      * @param[in]  inner_border Top and right inner border sizes. These rows and columns will be filled with zero.
  56      * @param[in]  info         Contains padding and stride information described in @ref PadStrideInfo.
  57      */
  58     void configure(const ICLTensor *input, ICLTensor *output, const BorderSize &inner_border, const PadStrideInfo &info);
  59     /** Static function to check if given info will lead to a valid configuration of @ref CLDeconvolutionLayerUpsample
  60      *
  61      * @param[in] input        Source tensor info. Data types supported: F32.
  62      * @param[in] output       Destination tensor info. Data types supported: F32. All but the lowest two dimensions must be the same size as in the input tensor, i.e. scaling is only performed within the XY-plane.
  63      * @param[in] inner_border Top and right inner border sizes. These rows and columns will be filled with zero.
  64      * @param[in] info         Contains padding and stride information described in @ref PadStrideInfo.
  65      *
  66      * @return a status
  67      */
  68     static Status validate(const ITensorInfo *input, const ITensorInfo *output, const BorderSize &inner_border, const PadStrideInfo &info);
  69
  70     // Inherited methods overridden:
  71     void run(const Window &window, cl::CommandQueue &queue) override;
  72
  73 private:
  74     const ICLTensor *_input;
  75     ICLTensor       *_output;
  76     BorderSize       _inner_border;
  77     PadStrideInfo    _info;
  78 };
  79 } // namespace arm_compute
  80 #endif /*__ARM_COMPUTE_CLDECONVOLUTIONLAYERUPSAMPLEKERNEL_H__ */