xref: /aosp_15_r20/external/ComputeLibrary/src/cpu/kernels/CpuCastKernel.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2016-2023 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_CAST_KERNEL_H
25 #define ARM_COMPUTE_CPU_CAST_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 /** Casts a given tensor to a new type
37  *
38  * @note When casting between quantized types the scale and zeroPoint are ignored
39  */
40 class CpuCastKernel : public ICpuKernel<CpuCastKernel>
41 {
42 private:
43     using CastKernelPtr = std::add_pointer<void(const ITensor *, ITensor *, const ThreadInfo &, ConvertPolicy, const Window &)>::type;
44 
45 public:
46     CpuCastKernel() = default;
47     ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE(CpuCastKernel);
48     /** Set the src and dst of the kernel
49      *
50      * Valid conversions src -> dst :
51      *
52      *   - QASYMM8_SIGNED -> S16, S32, F32, F16
53      *   - QASYMM8        -> U16, S16, S32, F32, F16
54      *   - U8             -> U16, S16, S32, F32, F16
55      *   - U16            -> U8, U32
56      *   - S16            -> QASYMM8_SIGNED, U8, S32
57      *   - BFLOAT16       -> F32
58      *   - F16            -> QASYMM8_SIGNED, QASYMM8, F32, S32, U8
59      *   - S32            -> QASYMM8_SIGNED, QASYMM8, F16, F32, U8
60      *   - F32            -> QASYMM8_SIGNED, QASYMM8, BFLOAT16, F16, S32, U8
61      *
62      * @param[in]  src    The src tensor to convert. Data types supported: QASYMM8_SIGNED/QASYMM8/U8/U16/S16/BFLOAT16/F16/F32.
63      * @param[out] dst    The dst tensor. Data types supported: QASYMM8_SIGNED/QASYMM8/U8/U16/S16/U32/S32/BFLOAT16/F16/F32.
64      * @param[in]  policy Conversion policy.
65      *
66      * @deprecated Support for BFLOAT16 will be removed in 23.05 release
67      */
68     void configure(const ITensorInfo *src, ITensorInfo *dst, ConvertPolicy policy);
69     /** Static function to check if given info will lead to a valid configuration
70      *
71      * Similar to @ref CpuCastKernel::configure()
72      *
73      * @return a status
74      */
75     static Status validate(const ITensorInfo *src, const ITensorInfo *dst, ConvertPolicy policy);
76 
77     // Inherited methods overridden:
78     void run_op(ITensorPack &tensors, const Window &window, const ThreadInfo &info) override;
79     const char *name() const override;
80 
81     struct CastKernel
82     {
83         const char                          *name;
84         const CastDataTypeISASelectorDataPtr is_selected;
85         CastKernelPtr                        ukernel;
86     };
87 
88     static const std::vector<CastKernel> &get_available_kernels();
89 
90 private:
91     ConvertPolicy _policy{ ConvertPolicy::SATURATE };
92 };
93 } // namespace kernels
94 } // namespace cpu
95 } // namespace arm_compute
96 #endif /* ARM_COMPUTE_CPU_CAST_KERNEL_H */
97