xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/runtime/NEON/functions/NEDequantizationLayer.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_NEDEQUANTIZATIONLAYER_H
25 #define ARM_COMPUTE_NEDEQUANTIZATIONLAYER_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 ITensor;
36 class ITensorInfo;
37 
38 /** Basic function to run @ref cpu::CpuDequantize that dequantizes an input tensor */
39 class NEDequantizationLayer : public IFunction
40 {
41 public:
42     /** Default Constructor */
43     NEDequantizationLayer();
44     /** Default Destructor */
45     ~NEDequantizationLayer();
46     /** Prevent instances of this class from being copied (As this class contains pointers) */
47     NEDequantizationLayer(const NEDequantizationLayer &) = delete;
48     /** Default move constructor */
49     NEDequantizationLayer(NEDequantizationLayer &&) = default;
50     /** Prevent instances of this class from being copied (As this class contains pointers) */
51     NEDequantizationLayer &operator=(const NEDequantizationLayer &) = delete;
52     /** Default move assignment operator */
53     NEDequantizationLayer &operator=(NEDequantizationLayer &&) = default;
54     /** Configure the kernel.
55      *
56      * Valid data layouts:
57      * - All
58      *
59      * Valid data type configurations:
60      * |src                |dst         |
61      * |:------------------|:-----------|
62      * |QASYMM8            |F16, F32    |
63      * |QASYMM8_SIGNED     |F16, F32    |
64      * |QSYMM8_PER_CHANNEL |F16, F32    |
65      * |QSYMM8             |F16, F32    |
66      * |QSYMM16            |F16, F32    |
67      *
68      * @param[in]  input  Source tensor. Data types supported: QASYMM8/QASYMM8_SIGNED/QSYMM8_PER_CHANNEL/QSYMM8/QSYMM16.
69      * @param[out] output Destination tensor with the same dimensions of input. Data type supported: F16/F32.
70      */
71     void configure(const ITensor *input, ITensor *output);
72     /** Static function to check if given info will lead to a valid configuration of @ref NEDequantizationLayer
73      *
74      * @param[in] input  Input tensor info. Data types supported: QASYMM8/QASYMM8_SIGNED/QSYMM8_PER_CHANNEL/QSYMM8/QSYMM16.
75      * @param[in] output Output tensor info. Data type supported: F16/F32.
76      *
77      * @return a status
78      */
79     static Status validate(const ITensorInfo *input, const ITensorInfo *output);
80 
81     // Inherited methods overridden:
82     void run() override;
83 
84 private:
85     struct Impl;
86     std::unique_ptr<Impl> _impl;
87 };
88 } // namespace arm_compute
89 #endif /* ARM_COMPUTE_NEDEQUANTIZATIONLAYER_H */
90