• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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_CLDECONVOLUTIONLAYERUPSAMPLE_H
25 #define ARM_COMPUTE_CLDECONVOLUTIONLAYERUPSAMPLE_H
26 
27 #include "arm_compute/core/Types.h"
28 #include "arm_compute/runtime/IFunction.h"
29 #include "arm_compute/runtime/IFunction.h"
30 
31 #include <memory>
32 
33 namespace arm_compute
34 {
35 // Forward declarations
36 class CLDeconvolutionLayerUpsampleKernel;
37 class CLCompileContext;
38 class CLMemsetKernel;
39 class ICLTensor;
40 class ITensorInfo;
41 
42 /** Basic function to execute deconvolution upsample on OpenCL. This function calls the following OpenCL kernels and functions:
43  *
44  * -# @ref CLMemsetKernel
45  * -# @ref CLDeconvolutionLayerUpsampleKernel
46  */
47 class CLDeconvolutionLayerUpsample : public IFunction
48 {
49 public:
50     /** Default constructor */
51     CLDeconvolutionLayerUpsample();
52     /** Prevent instances of this class from being copied (As this class contains pointers) */
53     CLDeconvolutionLayerUpsample(const CLDeconvolutionLayerUpsample &) = delete;
54     /** Prevent instances of this class from being copied (As this class contains pointers) */
55     CLDeconvolutionLayerUpsample &operator=(const CLDeconvolutionLayerUpsample &) = delete;
56     /** Allow instances of this class to be moved */
57     CLDeconvolutionLayerUpsample(CLDeconvolutionLayerUpsample &&) = default;
58     /** Allow instances of this class to be moved */
59     CLDeconvolutionLayerUpsample &operator=(CLDeconvolutionLayerUpsample &&) = default;
60     /** Default destructor */
61     ~CLDeconvolutionLayerUpsample();
62 
63     /** Initialize the function's source, destination, interpolation type and border_mode.
64      *
65      * @param[in, out] input  Source tensor. Data type supported: All.
66      * @param[out]     output Destination tensor. Data type supported: same as @p input.
67      * @param[in]      info   Contains padding and policies to be used in the deconvolution.
68      */
69     void configure(ICLTensor *input, ICLTensor *output, const PadStrideInfo &info);
70     /** Initialize the function's source, destination, interpolation type and border_mode.
71      *
72      * @param[in]      compile_context The compile context to be used.
73      * @param[in, out] input           Source tensor. Data type supported: All.
74      * @param[out]     output          Destination tensor. Data type supported: same as @p input.
75      * @param[in]      info            Contains padding and policies to be used in the deconvolution.
76      */
77     void configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output, const PadStrideInfo &info);
78     /** Static function to check if given info will lead to a valid configuration of @ref CLDeconvolutionLayerUpsample
79      *
80      * @param[in] input  Source tensor info. Data type supported: All.
81      * @param[in] output Destination tensor info. Data type supported: same as @p input.
82      * @param[in] info   Contains padding and policies to be used in the deconvolution.
83      *
84      * @return a status
85      */
86     static Status validate(const ITensorInfo *input, const ITensorInfo *output, const PadStrideInfo &info);
87 
88     // Inherited methods overridden:
89     void run() override;
90 
91 private:
92     std::unique_ptr<CLDeconvolutionLayerUpsampleKernel> _upsample;
93     std::unique_ptr<CLMemsetKernel>                     _memset;
94     ICLTensor                                          *_output;
95 };
96 } // namespace arm_compute
97 #endif /* ARM_COMPUTE_CLDECONVOLUTIONLAYERUPSAMPLE_H */
98