Compute Library
 23.08
CLCast.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018-2021, 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_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  * |S8 | U8, U16, S16, U32, S32, F16, F32 |
65  * |U16 | U8, S8, S16, U32, S32, F16, F32 |
66  * |S16 | U8, S8, U16, U32, S32, F16, F32 |
67  * |U32 | U8, S8, U16, S16, S32, F16, F32 |
68  * |S32 | U8, S8, U16, S16, U32, F16, F32 |
69  * |U64 | U8, S8, U16, S16, U32, S32, F16, F32 |
70  * |S64 | U8, S8, U16, S16, U32, S32, F16, F32 |
71  * |F16 | U8, S8, U16, S16, S32, U32, F32 |
72  * |F32 | U8, S8, U16, S16, S32, U32, F16 |
73  *
74  * Input data type must be different than output data type.
75  *
76  * @param[in] input The input tensor to convert. Data types supported: U8/S8/U16/S16/U32/S32/U64/S64/F16/F32.
77  * @param[out] output The output tensor. Data types supported: U8/S8/U16/S16/U32/S32/F16/F32.
78  * @param[in] policy Conversion policy.
79  */
80  void configure(const ICLTensor *input, ICLTensor *output, ConvertPolicy policy);
81  // Initialize the function's source, destination
82  void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, ConvertPolicy policy);
83  /** Static function to check if given info will lead to a valid configuration of @ref CLCast
84  *
85  * @param[in] input Source tensor info. Data types supported: U8/S8/U16/S16/U32/S32/U64/S64/F16/F32.
86  * @param[in] output Destination tensor info. Data type supported: U8/S8/U16/S16/U32/S32/F16/F32.
87  * @param[in] policy Conversion policy.
88  *
89  * @return a status
90  */
91  static Status validate(const ITensorInfo *input, const ITensorInfo *output, ConvertPolicy policy);
92 
93  // Inherited methods overridden:
94  void run() override;
95 
96 private:
97  struct Impl;
98  std::unique_ptr<Impl> _impl;
99 };
100 } // namespace arm_compute
101 #endif /*ARM_COMPUTE_CLCAST_H*/
arm_compute::IFunction
Base class for all functions.
Definition: IFunction.h:30
Types.h
arm_compute::ICLTensor
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
arm_compute::CLCast::configure
void configure(const ICLTensor *input, ICLTensor *output, ConvertPolicy policy)
Initialize the function's source, destination.
Definition: CLCast.cpp:53
arm_compute::CLCast
Basic function to run opencl::kernels::ClCastKernel.
Definition: CLCast.h:40
arm_compute::CLCompileContext
CLCompileContext class.
Definition: CLCompileContext.h:204
arm_compute::CLCast::operator=
CLCast & operator=(const CLCast &)=delete
Prevent instances of this class from being copied (As this class contains pointers)
arm_compute::CLCast::validate
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
arm_compute::Status
Status class.
Definition: Error.h:52
arm_compute::CLCast::run
void run() override
Run the kernels contained in the function.
Definition: CLCast.cpp:75
arm_compute::CLCast::~CLCast
~CLCast()
Destructor.
IFunction.h
arm_compute
Copyright (c) 2017-2023 Arm Limited.
Definition: introduction.dox:24
arm_compute::ConvertPolicy
ConvertPolicy
Policy to handle integer overflow.
Definition: Types.h:364
arm_compute::ITensorInfo
Store the tensor's metadata.
Definition: ITensorInfo.h:43
arm_compute::CLCast::CLCast
CLCast()
Constructor.
Definition: CLCast.cpp:45
arm_compute::test::validation::input
auto input
Definition: LSTMLayerQuantized.cpp:486