xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/runtime/CL/functions/CLDeconvolutionLayerUpsample.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2017-2021 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/CL/functions/CLFill.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 ICLTensor;
39 class ITensorInfo;
40 
41 /** Basic function to execute deconvolution upsample on OpenCL. This function calls the following OpenCL kernels and functions:
42  *
43  * -# @ref CLFill
44  * -# @ref CLDeconvolutionLayerUpsampleKernel
45  */
46 class CLDeconvolutionLayerUpsample : public IFunction
47 {
48 public:
49     /** Default constructor */
50     CLDeconvolutionLayerUpsample();
51     /** Prevent instances of this class from being copied (As this class contains pointers) */
52     CLDeconvolutionLayerUpsample(const CLDeconvolutionLayerUpsample &) = delete;
53     /** Prevent instances of this class from being copied (As this class contains pointers) */
54     CLDeconvolutionLayerUpsample &operator=(const CLDeconvolutionLayerUpsample &) = delete;
55     /** Allow instances of this class to be moved */
56     CLDeconvolutionLayerUpsample(CLDeconvolutionLayerUpsample &&) = default;
57     /** Allow instances of this class to be moved */
58     CLDeconvolutionLayerUpsample &operator=(CLDeconvolutionLayerUpsample &&) = default;
59     /** Default destructor */
60     ~CLDeconvolutionLayerUpsample();
61 
62     /** Initialize the function's source, destination, interpolation type and border_mode.
63      *
64      * Valid data layouts:
65      * - NHWC
66      * - NCHW
67      *
68      * Valid data type configurations:
69      * |src            |dst            |
70      * |:--------------|:--------------|
71      * |All            |All            |
72      *
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(ICLTensor *input, ICLTensor *output, const PadStrideInfo &info);
78     /** Initialize the function's source, destination, interpolation type and border_mode.
79      *
80      * @param[in]      compile_context The compile context to be used.
81      * @param[in, out] input           Source tensor. Data type supported: All.
82      * @param[out]     output          Destination tensor. Data type supported: same as @p input.
83      * @param[in]      info            Contains padding and policies to be used in the deconvolution.
84      */
85     void configure(const CLCompileContext &compile_context, ICLTensor *input, ICLTensor *output, const PadStrideInfo &info);
86     /** Static function to check if given info will lead to a valid configuration of @ref CLDeconvolutionLayerUpsample
87      *
88      * @param[in] input  Source tensor info. Data type supported: All.
89      * @param[in] output Destination tensor info. Data type supported: same as @p input.
90      * @param[in] info   Contains padding and policies to be used in the deconvolution.
91      *
92      * @return a status
93      */
94     static Status validate(const ITensorInfo *input, const ITensorInfo *output, const PadStrideInfo &info);
95 
96     // Inherited methods overridden:
97     void run() override;
98 
99 private:
100     std::unique_ptr<CLDeconvolutionLayerUpsampleKernel> _upsample;
101     CLFill                                              _fill;
102     ICLTensor                                          *_output;
103 };
104 } // namespace arm_compute
105 #endif /* ARM_COMPUTE_CLDECONVOLUTIONLAYERUPSAMPLE_H */
106