Compute Library
 22.05
CLDepthConvertLayer.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-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_CLDEPTHCONVERT_H
25 #define ARM_COMPUTE_CLDEPTHCONVERT_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 */
41 {
42 public:
43  /** Constructor */
45  /** Destructor */
47  /** Prevent instances of this class from being copied (As this class contains pointers) */
48  CLDepthConvertLayer(const CLDepthConvertLayer &) = delete;
49  /** Default move constructor */
51  /** Prevent instances of this class from being copied (As this class contains pointers) */
53  /** Default move assignment operator */
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  * @param[in] shift Value for down/up conversions. Must be 0 <= shift < 8.
77  */
78  void configure(const ICLTensor *input, ICLTensor *output, ConvertPolicy policy, uint32_t shift);
79  /** Initialize the function's source, destination
80  *
81  * Input data type must be different than output data type.
82  *
83  * Valid conversions Input -> Output :
84  *
85  * - U8 -> S8, U16, S16, U32, S32, F16, F32
86  * - U16 -> U8, S8, S16, U32, S32, F16, F32
87  * - S16 -> U8, S8, U16, U32, S32, F16, F32
88  * - U32 -> U8, S8, U16, S16, S32, F16, F32
89  * - S32 -> U8, S8, U16, S16, U32, F16, F32
90  * - F16 -> U8, S8, U16, S16, U32, F32
91  * - F32 -> U8, S8, U16, S16, U32, F16
92  *
93  * @param[in] compile_context The compile context to be used.
94  * @param[in] input The input tensor to convert. Data types supported: U8/S8/U16/S16/U32/S32/F16/F32.
95  * @param[out] output The output tensor. Data types supported: U8/S8/U16/S16/U32/S32/F16/F32.
96  * @param[in] policy Conversion policy.
97  * @param[in] shift Value for down/up conversions. Must be 0 <= shift < 8.
98  */
99  void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, ConvertPolicy policy, uint32_t shift);
100  /** Static function to check if given info will lead to a valid configuration of @ref CLDepthConvertLayer
101  *
102  * @param[in] input Source tensor info. Data types supported: U8/S8/U16/S16/U32/S32/F16/F32.
103  * @param[in] output Destination tensor info. Data type supported: U8/S8/U16/S16/U32/S32/F16/F32.
104  * @param[in] policy Conversion policy.
105  * @param[in] shift Value for down/up conversions. Must be 0 <= shift < 8.
106  *
107  * @return a status
108  */
109  static Status validate(const ITensorInfo *input, const ITensorInfo *output, ConvertPolicy policy, uint32_t shift);
110 
111  // Inherited methods overridden:
112  void run() override;
113 
114 private:
115  struct Impl;
116  std::unique_ptr<Impl> _impl;
117 };
118 } // namespace arm_compute
119 #endif /*ARM_COMPUTE_CLDEPTHCONVERT_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
Copyright (c) 2017-2022 Arm Limited.
void run() override
Run the kernels contained in the function.
CLDepthConvertLayer & operator=(const CLDepthConvertLayer &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
CLCompileContext class.
void configure(const ICLTensor *input, ICLTensor *output, ConvertPolicy policy, uint32_t shift)
Initialize the function&#39;s source, destination.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
Basic function to run opencl::kernels::ClCastKernel.
static Status validate(const ITensorInfo *input, const ITensorInfo *output, ConvertPolicy policy, uint32_t shift)
Static function to check if given info will lead to a valid configuration of CLDepthConvertLayer.
ConvertPolicy
Policy to handle integer overflow.
Definition: Types.h:404