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