Compute Library
 22.08
NECast.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019-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_NECAST_H
25 #define ARM_COMPUTE_NECAST_H
26 
28 
29 #include "arm_compute/core/Types.h"
30 
31 #include <memory>
32 
33 namespace arm_compute
34 {
35 class ITensor;
36 class ITensorInfo;
37 
38 /** Basic function to run @ref cpu::kernels::CpuCastKernel.
39  * This function ignores the scale and zeroPoint of quanized tensors,so QASYMM8 input is treated as uint8 values.
40  */
41 class NECast : public IFunction
42 {
43 public:
44  /** Constructor */
45  NECast();
46  /** Destructor */
47  ~NECast();
48  /** Prevent instances of this class from being copied (As this class contains pointers) */
49  NECast(const NECast &) = delete;
50  /** Default move constructor */
51  NECast(NECast &&);
52  /** Prevent instances of this class from being copied (As this class contains pointers) */
53  NECast &operator=(const NECast &) = delete;
54  /** Default move assignment operator */
55  NECast &operator=(NECast &&);
56  /** Initialize the function's source, destination
57  *
58  * Valid data layouts:
59  * - All
60  *
61  * Valid data type configurations:
62  * |src |dst |
63  * |:--------------|:-----------------------------------------------|
64  * |QASYMM8_SIGNED | S16, S32, F32, F16 |
65  * |QASYMM8 | U16, S16, S32, F32, F16 |
66  * |U8 | U16, S16, S32, F32, F16 |
67  * |U16 | U8, U32 |
68  * |S16 | QASYMM8_SIGNED, U8, S32 |
69  * |F16 | QASYMM8_SIGNED, QASYMM8, F32, S32, U8 |
70  * |S32 | QASYMM8_SIGNED, QASYMM8, F16, F32, U8 |
71  * |F32 | QASYMM8_SIGNED, QASYMM8, BFLOAT16, F16, S32, U8|
72  *
73  * Input data type must be different than output data type.
74  *
75  * @param[in] input The input tensor to convert. Data types supported: QASYMM8_SIGNED/QASYMM8/U8/U16/S16/F16/S32/F32.
76  * @param[out] output The output tensor. Data types supported: QASYMM8_SIGNED/QASYMM8/U8/S8/U16/S16/U32/S32/BFLOAT16/F16/F32.
77  * @param[in] policy Conversion policy.
78  */
79  void configure(ITensor *input, ITensor *output, ConvertPolicy policy);
80  /** Static function to check if given info will lead to a valid configuration of @ref NECast
81  *
82  * @param[in] input Source tensor info. Data types supported: QASYMM8_SIGNED/QASYMM8/U8/U16/S16/F16/S32/F32.
83  * @param[in] output Destination tensor info. Data type supported: QASYMM8_SIGNED/QASYMM8/U8/S8/U16/S16/U32/S32/BFLOAT16/F16/F32.
84  * @param[in] policy Conversion policy.
85  *
86  * @return a status
87  */
88  static Status validate(ITensorInfo *input, ITensorInfo *output, ConvertPolicy policy);
89 
90  // Inherited methods overridden
91  void run() override;
92 
93 private:
94  struct Impl;
95  std::unique_ptr<Impl> _impl;
96 };
97 } // namespace arm_compute
98 #endif /*ARM_COMPUTE_NECAST_H*/
Base class for all functions.
Definition: IFunction.h:30
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Interface for CPU tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2022 Arm Limited.
NECast & operator=(const NECast &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
Basic function to run cpu::kernels::CpuCastKernel.
Definition: NECast.h:41
~NECast()
Destructor.
void configure(ITensor *input, ITensor *output, ConvertPolicy policy)
Initialize the function&#39;s source, destination.
Definition: NECast.cpp:47
static Status validate(ITensorInfo *input, ITensorInfo *output, ConvertPolicy policy)
Static function to check if given info will lead to a valid configuration of NECast.
Definition: NECast.cpp:58
void run() override
Run the kernels contained in the function.
Definition: NECast.cpp:63
NECast()
Constructor.
Definition: NECast.cpp:39
ConvertPolicy
Policy to handle integer overflow.
Definition: Types.h:404