Compute Library
 22.05
CLStackLayer.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_CLSTACKLAYER_H
25 #define ARM_COMPUTE_CLSTACKLAYER_H
26 
27 #include "arm_compute/core/Types.h"
29 
30 #include <memory>
31 #include <vector>
32 
33 namespace arm_compute
34 {
35 class CLCompileContext;
36 class CLStackLayerKernel;
37 class ICLTensor;
38 class ITensorInfo;
39 
40 /** Basic function to stack tensors along an axis. This function calls the following kernel:
41  *
42  * -# @ref CLStackLayerKernel
43  *
44  */
45 class CLStackLayer : public IFunction
46 {
47 public:
48  /** Default constructor */
49  CLStackLayer();
50  /** Prevent instances of this class from being copied */
51  CLStackLayer(const CLStackLayer &) = delete;
52  /** Prevent instances of this class from being copied */
53  CLStackLayer &operator=(const CLStackLayer &) = delete;
54  /** Prevent instances of this class to be moved */
55  CLStackLayer(CLStackLayer &&) = delete;
56  /** Prevent instances of this class to be moved */
57  CLStackLayer &operator=(CLStackLayer &&) = delete;
58  /** Default destructor */
59  ~CLStackLayer();
60  /** Initialise the kernel's inputs vector and output.
61  *
62  * Valid data layouts:
63  * - All
64  *
65  * Valid data type configurations:
66  * |src |dst |
67  * |:--------------|:--------------|
68  * |All |All |
69  *
70  * @note Supported input tensor rank: up to 4
71  *
72  * @param[in] input The vectors containing all the tensors with the same shape to stack. Data types supported: All.
73  * @param[in] axis The dimension to stack the tensors along. It must be smaller than the number of input dimensions.
74  * Negative values wrap around
75  * @param[out] output Output tensor. Data types supported: Same as @p input.
76  */
77  void configure(const std::vector<ICLTensor *> &input, int axis, ICLTensor *output);
78  /** Initialise the kernel's inputs vector and output.
79  *
80  * @note Supported input tensor rank: up to 4
81  *
82  * @param[in] compile_context The compile context to be used.
83  * @param[in] input The vectors containing all the tensors with the same shape to stack. Data types supported: All.
84  * @param[in] axis The dimension to stack the tensors along. It must be smaller than the number of input dimensions.
85  * Negative values wrap around
86  * @param[out] output Output tensor. Data types supported: Same as @p input.
87  */
88  void configure(const CLCompileContext &compile_context, const std::vector<ICLTensor *> &input, int axis, ICLTensor *output);
89  /** Static function to check if given info will lead to a valid configuration of @ref CLStackLayerKernel
90  *
91  * @note Supported input tensor rank: up to 4
92  *
93  * @param[in] input The vectors containing all the tensors info with the same shape to stack. Data types supported: All.
94  * @param[in] axis The dimension to stack the tensors along. It must be smaller than the number of input dimensions.
95  * Negative values wrap around
96  * @param[in] output Output tensor info. Data types supported: Same as @p input.
97  *
98  * @return a status
99  */
100  static Status validate(const std::vector<ITensorInfo *> &input, int axis, const ITensorInfo *output);
101 
102  // Inherited methods overridden:
103  void run() override;
104 
105 private:
106  std::vector<ICLTensor *> _input;
107  std::vector<std::unique_ptr<CLStackLayerKernel>> _stack_kernels;
108  unsigned int _num_inputs;
109 };
110 } // namespace arm_compute
111 #endif /* ARM_COMPUTE_CLSTACKLAYER_H */
void configure(const std::vector< ICLTensor *> &input, int axis, ICLTensor *output)
Initialise the kernel&#39;s inputs vector and output.
Base class for all functions.
Definition: IFunction.h:30
void run() override
Run the kernels contained in the function.
CLStackLayer()
Default constructor.
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Copyright (c) 2017-2022 Arm Limited.
CLStackLayer & operator=(const CLStackLayer &)=delete
Prevent instances of this class from being copied.
static Status validate(const std::vector< ITensorInfo *> &input, int axis, const ITensorInfo *output)
Static function to check if given info will lead to a valid configuration of CLStackLayerKernel.
~CLStackLayer()
Default destructor.
CLCompileContext class.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
Basic function to stack tensors along an axis.
Definition: CLStackLayer.h:45