xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/runtime/CL/functions/CLQuantizationLayer.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_CLQUANTIZATIONLAYER_H
25 #define ARM_COMPUTE_CLQUANTIZATIONLAYER_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 class CLCompileContext;
35 class ICLTensor;
36 class ITensorInfo;
37 
38 /** Basic function to simulate a quantization layer. This function calls the following CL kernels:
39  *
40  * -# @ref opencl::ClQuantize
41  *
42  * @note The implementation supports only 3D input tensors.
43  *
44  */
45 class CLQuantizationLayer : public IFunction
46 {
47 public:
48     /** Default Constructor */
49     CLQuantizationLayer();
50     /** Default Destructor */
51     ~CLQuantizationLayer();
52     /** Prevent instances of this class from being copied (As this class contains pointers) */
53     CLQuantizationLayer(const CLQuantizationLayer &) = delete;
54     /** Default move constructor */
55     CLQuantizationLayer(CLQuantizationLayer &&) = default;
56     /** Prevent instances of this class from being copied (As this class contains pointers) */
57     CLQuantizationLayer &operator=(const CLQuantizationLayer &) = delete;
58     /** Default move assignment operator */
59     CLQuantizationLayer &operator=(CLQuantizationLayer &&) = default;
60     /** Set the input and output tensors.
61      *
62      * Valid data layouts:
63      * - All
64      *
65      * Valid data type configurations:
66      * |src                |dst                                |
67      * |:------------------|:----------------------------------|
68      * |QASYMM8            |QASYMM8, QASYMM8_SIGNED, QASYMM16  |
69      * |QASYMM8_SIGNED     |QASYMM8, QASYMM8_SIGNED, QASYMM16  |
70      * |F16                |QASYMM8, QASYMM8_SIGNED, QASYMM16  |
71      * |F32                |QASYMM8, QASYMM8_SIGNED, QASYMM16  |
72      *
73      * @param[in]  input  Source tensor. The dimensions over the third will be interpreted as batches. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/32.
74      * @param[out] output Destination tensor with the same dimensions of input. Data types supported: QASYMM8/QASYMM8_SIGNED/QASYMM16.
75      *
76      * @note Output auto initialization is not supported by this function
77      */
78     void configure(const ICLTensor *input, ICLTensor *output);
79     /** Set the input and output tensors.
80      *
81      * @param[in]  compile_context The compile context to be used.
82      * @param[in]  input           Source tensor. The dimensions over the third will be interpreted as batches. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/32.
83      * @param[out] output          Destination tensor with the same dimensions of input. Data types supported: QASYMM8/QASYMM8_SIGNED/QASYMM16.
84      *
85      * @note Output auto initialization is not supported by this function
86      */
87     void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output);
88     /** Static function to check if given info will lead to a valid configuration of @ref CLQuantizationLayer
89      *
90      * @param[in] input  Input tensor info. The dimensions over the third will be interpreted as batches. Data types supported: QASYMM8/QASYMM8_SIGNED/F16/32.
91      * @param[in] output Output tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/QASYMM16.
92      *
93      * @return a status
94      */
95     static Status validate(const ITensorInfo *input, const ITensorInfo *output);
96 
97     // Inherited methods overridden:
98     void run() override;
99 
100 private:
101     struct Impl;
102     std::unique_ptr<Impl> _impl;
103 };
104 } //namespace arm_compute
105 #endif /* ARM_COMPUTE_CLQUANTIZATIONLAYER_H */
106