xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/runtime/CL/functions/CLDequantizationLayer.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_CLDEQUANTIZATIONLAYER_H
25 #define ARM_COMPUTE_CLDEQUANTIZATIONLAYER_H
26 
27 #include "arm_compute/core/Types.h"
28 #include "arm_compute/runtime/IFunction.h"
29 
30 #include <memory>
31 
32 namespace arm_compute
33 {
34 // Forward declarations
35 class CLCompileContext;
36 class ICLTensor;
37 class ITensorInfo;
38 
39 /** Basic function to run @ref opencl::ClDequantize that dequantizes an input tensor */
40 class CLDequantizationLayer : public IFunction
41 {
42 public:
43     /** Default Constructor */
44     CLDequantizationLayer();
45     /** Default Destructor */
46     ~CLDequantizationLayer();
47     /** Prevent instances of this class from being copied (As this class contains pointers) */
48     CLDequantizationLayer(const CLDequantizationLayer &) = delete;
49     /** Default move constructor */
50     CLDequantizationLayer(CLDequantizationLayer &&) = default;
51     /** Prevent instances of this class from being copied (As this class contains pointers) */
52     CLDequantizationLayer &operator=(const CLDequantizationLayer &) = delete;
53     /** Default move assignment operator */
54     CLDequantizationLayer &operator=(CLDequantizationLayer &&) = default;
55     /** Set the input and output tensors.
56      *
57      * Valid data layouts:
58      * - All
59      *
60      * Valid data type configurations:
61      * |src                |dst       |
62      * |:------------------|:---------|
63      * |QASYMM8            |F16, F32  |
64      * |QASYMM8_SIGNED     |F16, F32  |
65      * |QSYMM8_PER_CHANNEL |F16, F32  |
66      * |QSYMM8             |F16, F32  |
67      * |QSYMM16            |F16, F32  |
68      *
69      * @param[in]  input  Source tensor with at least 3 dimensions. The dimensions over the third will be interpreted as batches.
70      *                    Data types supported: QASYMM8/QASYMM8_SIGNED/QSYMM8_PER_CHANNEL/QSYMM8/QSYMM16.
71      * @param[out] output Destination tensor with the same dimensions of input. Data type supported: F16/F32.
72      */
73     void configure(const ICLTensor *input, ICLTensor *output);
74     /** Set the input and output tensors.
75      *
76      * @param[in]  compile_context The compile context to be used.
77      * @param[in]  input           Source tensor with at least 3 dimensions. The dimensions over the third will be interpreted as batches.
78      *                             Data types supported: QASYMM8/QASYMM8_SIGNED/QSYMM8_PER_CHANNEL/QSYMM8/QSYMM16.
79      * @param[out] output          Destination tensor with the same dimensions of input. Data type supported: F16/F32.
80      */
81     void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output);
82     /** Static function to check if given info will lead to a valid configuration of @ref CLDequantizationLayer
83      *
84      * @param[in] input  Input tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/QSYMM8_PER_CHANNEL/QSYMM8/QSYMM16.
85      * @param[in] output Output tensor info. Data type supported: F16/F32.
86      *
87      * @return a status
88      */
89     static Status validate(const ITensorInfo *input, const ITensorInfo *output);
90 
91     // Inherited methods overridden:
92     void run() override;
93 
94 private:
95     struct Impl;
96     std::unique_ptr<Impl> _impl;
97 };
98 } // namespace arm_compute
99 #endif /* ARM_COMPUTE_CLDEQUANTIZATIONLAYER_H */
100