Compute Library
 21.02
NEDepthConvertLayer.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-2020 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_NEDEPTHCONVERT_H
25 #define ARM_COMPUTE_NEDEPTHCONVERT_H
26 
27 #include "arm_compute/core/Types.h"
29 
30 #include <cstdint>
31 
32 namespace arm_compute
33 {
34 class ITensor;
35 class ITensorInfo;
36 
37 /**Basic function to run @ref NEDepthConvertLayerKernel */
39 {
40 public:
41  /* Contructor */
42  NEDepthConvertLayer() = default;
43  /** Prevent instances of this class from being copied (As this class contains pointers)*/
44  NEDepthConvertLayer(const NEDepthConvertLayer &) = delete;
45  /** Prevent instances of this class from being copied (As this class contains pointers)*/
46  const NEDepthConvertLayer &operator=(const NEDepthConvertLayer &) = delete;
47  /** Default destructor */
48  ~NEDepthConvertLayer() = default;
49  /** Initialize the function's source, destination
50  *
51  * Valid conversions Input -> Output :
52  *
53  * - QASYMM8 -> F16, F32
54  * - U8 -> U16, S16, S32
55  * - U16 -> U8, U32
56  * - S16 -> U8, S32
57  * - BFLOAT16 -> F32
58  * - F16 -> QASYMM8, F32
59  * - F32 -> QASYMM8, F16, BFLOAT16
60  *
61  * @param[in] input The input tensor to convert. Data types supported: QASYMM8/U8/U16/S16/BFLOAT16/F16/F32.
62  * @param[out] output The output tensor. Data types supported: QASYMM8/U8/U16/S16/U32/S32/BFLOAT16/F16/F32.
63  * @param[in] policy Conversion policy.
64  * @param[in] shift (Optional) Value for down/up conversions. Must be 0 <= shift < 8.
65  */
66  void configure(const ITensor *input, ITensor *output, ConvertPolicy policy, uint32_t shift = 0);
67  /** Static function to check if given info will lead to a valid configuration of @ref NEDepthConvertLayer
68  *
69  * @param[in] input Source tensor info. Data types supported: QASYMM8/U8/U16/S16/BFLOAT16/F16/F32.
70  * @param[in] output Destination tensor info. Data type supported: QASYMM8/U8/U16/S16/U32/S32/BFLOAT16/F16/F32.
71  * @param[in] policy Conversion policy.
72  * @param[in] shift (Optional) Value for down/up conversions. Must be 0 <= shift < 8.
73  *
74  * @return a status
75  */
76  static Status validate(const ITensorInfo *input, const ITensorInfo *output, ConvertPolicy policy, uint32_t shift = 0);
77 };
78 } // namespace arm_compute
79 #endif /*ARM_COMPUTE_NEDEPTHCONVERT_H*/
const NEDepthConvertLayer & operator=(const NEDepthConvertLayer &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Interface for Neon tensor.
Definition: ITensor.h:36
Copyright (c) 2017-2021 Arm Limited.
static Status validate(const ITensorInfo *input, const ITensorInfo *output, ConvertPolicy policy, uint32_t shift=0)
Static function to check if given info will lead to a valid configuration of NEDepthConvertLayer.
Basic interface for functions which have a single Neon kernel and no border.
~NEDepthConvertLayer()=default
Default destructor.
Basic function to run NEDepthConvertLayerKernel.
void configure(const ITensor *input, ITensor *output, ConvertPolicy policy, uint32_t shift=0)
Initialize the function&#39;s source, destination.
ConvertPolicy
Policy to handle overflow.
Definition: Types.h:385