Compute Library
 22.05
CLDepthToSpaceLayer.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_CLDEPTHTOSPACELAYER_H
25 #define ARM_COMPUTE_CLDEPTHTOSPACELAYER_H
26 
27 #include "arm_compute/core/Types.h"
29 
30 namespace arm_compute
31 {
32 class CLCompileContext;
33 class ICLTensor;
34 class ITensorInfo;
35 
36 /** Basic function to run @ref CLDepthToSpaceLayerKernel. */
38 {
39 public:
40  /** Set the input and output tensors.
41  *
42  * Valid data layouts:
43  * - NHWC
44  * - NCHW
45  *
46  * Valid data type configurations:
47  * |src |dst |
48  * |:--------------|:--------------|
49  * |All |All |
50  *
51  * @param[in] input Tensor input. Supported tensor rank: 4. Data types supported: All.
52  * @param[out] output Tensor output. Data types supported: same as @p input
53  * @param[in] block_shape Block shape value.
54  */
55  void configure(const ICLTensor *input, ICLTensor *output, int32_t block_shape);
56  /** Set the input and output tensors.
57  *
58  * @param[in] compile_context The compile context to be used.
59  * @param[in] input Tensor input. Supported tensor rank: 4. Data types supported: All.
60  * @param[out] output Tensor output. Data types supported: same as @p input
61  * @param[in] block_shape Block shape value.
62  */
63  void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, int32_t block_shape);
64  /** Static function to check if given info will lead to a valid configuration of @ref CLDepthToSpaceLayer.
65  *
66  * @param[in] input Tensor input info. Supported tensor rank: 4. Data types supported: All.
67  * @param[in] output Tensor output info. Data types supported: same as @p input
68  * @param[in] block_shape Block shape value.
69  *
70  * @return a status
71  */
72  static Status validate(const ITensorInfo *input, const ITensorInfo *output, int32_t block_shape);
73 };
74 }
75 #endif /* ARM_COMPUTE_CLDEPTHTOSPACELAYER_H */
Basic function to run CLDepthToSpaceLayerKernel.
Store the tensor's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
static Status validate(const ITensorInfo *input, const ITensorInfo *output, int32_t block_shape)
Static function to check if given info will lead to a valid configuration of CLDepthToSpaceLayer.
Copyright (c) 2017-2022 Arm Limited.
Basic interface for functions which have a single OpenCL kernel.
CLCompileContext class.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
void configure(const ICLTensor *input, ICLTensor *output, int32_t block_shape)
Set the input and output tensors.