xref: /aosp_15_r20/external/ComputeLibrary/src/cpu/kernels/CpuQuantizeKernel.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2017-2022 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_CPU_QUANTIZE_KERNEL_H
25 #define ARM_COMPUTE_CPU_QUANTIZE_KERNEL_H
26 
27 #include "src/core/common/Macros.h"
28 #include "src/cpu/ICpuKernel.h"
29 
30 namespace arm_compute
31 {
32 namespace cpu
33 {
34 namespace kernels
35 {
36 /** Interface for the quantization layer kernel.
37  *
38  * @note The implementation supports only 3D input tensors
39  */
40 class CpuQuantizeKernel : public ICpuKernel<CpuQuantizeKernel>
41 {
42 public:
43     CpuQuantizeKernel() = default;
44     ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE(CpuQuantizeKernel);
45     /** Set the input, output.
46      *
47      * @param[in]  src Source tensor info. The dimensions over the third will be interpreted as batches. Data types supported: QASYMM8/QASYMM8_SIGNED/F32/F16.
48      * @param[out] dst Destination tensor info with the same dimensions of input. Data types supported: QASYMM8/QASYMM8_SIGNED/QASYMM16.
49      *
50      * @note Output auto initialization is not supported by this kernel
51      */
52     void configure(const ITensorInfo *src, ITensorInfo *dst);
53     /** Static function to check if given info will lead to a valid configuration
54      *
55      * Similar to @ref CpuQuantizeKernel::configure()
56      *
57      * @return a status
58      */
59     static Status validate(const ITensorInfo *src, const ITensorInfo *dst);
60 
61     // Inherited methods overridden:
62     void run_op(ITensorPack &tensors, const Window &window, const ThreadInfo &info) override;
63     const char *name() const override;
64 
65 private:
66     /** Common signature for all the specialised @ref CpuQuantizeKernel functions
67      *
68      * @param[in] window Region on which to execute the kernel.
69      */
70     using QuantizeFunctionExecutorPtr = void (CpuQuantizeKernel::*)(const ITensor *src, ITensor *dst, const Window &window);
71     /** Function to apply QASYMM8 or QASYMM8_SIGNED quantization on a tensor.
72      *
73      * @param[in] window Region on which to execute the kernel.
74      */
75     template <typename TIn, typename TOut>
76     void run_quantize_qasymm8(const ITensor *src, ITensor *dst, const Window &window);
77     /** Function to apply QASYMM16 quantization on a tensor.
78      *
79      * @param[in] window Region on which to execute the kernel.
80      */
81     template <typename T>
82     void run_quantize_qasymm16(const ITensor *src, ITensor *dst, const Window &window);
83 
84     template <typename TIn, typename TOut>
85     void run_quantize_qsymm8(const ITensor *src, ITensor *dst, const Window &window);
86 
87     QuantizeFunctionExecutorPtr _func{ nullptr };
88 };
89 } // namespace kernels
90 } // namespace cpu
91 } // namespace arm_compute
92 #endif /* ARM_COMPUTE_CPU_QUANTIZE_KERNEL_H */
93