Compute Library
 20.02.1
CLStackLayer.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018-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_CLSTACKLAYER_H
25 #define ARM_COMPUTE_CLSTACKLAYER_H
26 
27 #include "arm_compute/core/Types.h"
29 
31 
32 #include <memory>
33 #include <vector>
34 
35 namespace arm_compute
36 {
37 class ICLTensor;
38 
39 /** Basic function to stack tensors along an axis. This function calls the following kernel:
40  *
41  * -# @ref CLStackLayerKernel
42  *
43  */
44 class CLStackLayer : public IFunction
45 {
46 public:
47  /** Default constructor */
48  CLStackLayer();
49  /** Initialise the kernel's inputs vector and output.
50  *
51  * @note Supported input tensor rank: up to 4
52  *
53  * @param[in] input The vectors containing all the tensors with the same shape to stack. Data types supported: All.
54  * @param[in] axis The dimension to stack the tensors along. It must be smaller than the number of input dimensions.
55  * Negative values wrap around
56  * @param[out] output Output tensor. Data types supported: Same as @p input.
57  */
58  void configure(const std::vector<ICLTensor *> &input, int axis, ICLTensor *output);
59  /** Static function to check if given info will lead to a valid configuration of @ref CLStackLayerKernel
60  *
61  * @note Supported input tensor rank: up to 4
62  *
63  * @param[in] input The vectors containing all the tensors info with the same shape to stack. Data types supported: All.
64  * @param[in] axis The dimension to stack the tensors along. It must be smaller than the number of input dimensions.
65  * Negative values wrap around
66  * @param[in] output Output tensor info. Data types supported: Same as @p input.
67  *
68  * @return a status
69  */
70  static Status validate(const std::vector<ITensorInfo *> &input, int axis, const ITensorInfo *output);
71 
72  // Inherited methods overridden:
73  void run() override;
74 
75 private:
76  std::vector<ICLTensor *> _input;
77  std::vector<CLStackLayerKernel> _stack_kernels;
78  unsigned int _num_inputs;
79 };
80 } // namespace arm_compute
81 #endif /* ARM_COMPUTE_CLSTACKLAYER_H */
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's metadata.
Definition: ITensorInfo.h:40
Status class.
Definition: Error.h:52
Copyright (c) 2017-2020 ARM Limited.
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.
void configure(const std::vector< ICLTensor * > &input, int axis, ICLTensor *output)
Initialise the kernel's inputs vector and output.
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
Basic function to stack tensors along an axis.
Definition: CLStackLayer.h:44