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