Compute Library
 21.02
NEStackLayer.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_NESTACKLAYER_H
25 #define ARM_COMPUTE_NESTACKLAYER_H
26 
27 #include "arm_compute/core/Types.h"
29 
30 #include <memory>
31 #include <vector>
32 
33 namespace arm_compute
34 {
35 class ITensor;
36 class ITensorInfo;
37 class NEStackLayerKernel;
38 
39 /** Basic function to stack tensors along an axis. This function calls the following kernel:
40  *
41  * -# @ref NEStackLayerKernel
42  *
43  */
44 class NEStackLayer : public IFunction
45 {
46 public:
47  /** Default constructor */
48  NEStackLayer();
49  /** Prevent instances of this class from being copied (As this class contains pointers) */
50  NEStackLayer(const NEStackLayer &) = delete;
51  /** Prevent instances of this class from being copied (As this class contains pointers) */
52  NEStackLayer &operator=(const NEStackLayer &) = delete;
53  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
54  NEStackLayer(NEStackLayer &&) = delete;
55  /** Prevent instances of this class from being moved (As this class contains non movable objects) */
56  NEStackLayer &operator=(NEStackLayer &&) = delete;
57  /** Default destructor */
58  ~NEStackLayer();
59  /** Initialise the kernel's inputs vector and output.
60  *
61  * @note Supported input tensor rank: up to 4
62  *
63  * @param[in] input The vectors containing all the tensors 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[out] output Output tensor. Data types supported: Same as @p input.
67  */
68  void configure(const std::vector<ITensor *> &input, int axis, ITensor *output);
69  /** Static function to check if given info will lead to a valid configuration of @ref NEStackLayerKernel
70  *
71  * @note Supported input tensor rank: up to 4
72  *
73  * @param[in] input The vectors containing all the tensors info with the same shape to stack. Data types supported: All
74  * @param[in] axis The dimension to stack the tensors along. It must be smaller than the number of input dimensions.
75  * Negative values wrap around
76  * @param[in] output Output tensor info. Data types supported: Same as @p input.
77  *
78  * @return a status
79  */
80  static Status validate(const std::vector<ITensorInfo *> &input, int axis, const ITensorInfo *output);
81 
82  // Inherited methods overridden:
83  void run() override;
84 
85 private:
86  std::vector<ITensor *> _input;
87  std::vector<std::unique_ptr<NEStackLayerKernel>> _stack_kernels;
88  unsigned int _num_inputs;
89 };
90 } // namespace arm_compute
91 #endif /* ARM_COMPUTE_NESTACKLAYER_H */
Base class for all functions.
Definition: IFunction.h:30
void configure(const std::vector< ITensor *> &input, int axis, ITensor *output)
Initialise the kernel&#39;s inputs vector and output.
NEStackLayer & operator=(const NEStackLayer &)=delete
Prevent instances of this class from being copied (As this class contains pointers) ...
~NEStackLayer()
Default destructor.
Store the tensor&#39;s metadata.
Definition: ITensorInfo.h:40
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 NEStackLayerKernel.
Status class.
Definition: Error.h:52
Interface for Neon tensor.
Definition: ITensor.h:36
void run() override
Run the kernels contained in the function.
Copyright (c) 2017-2021 Arm Limited.
Basic function to stack tensors along an axis.
Definition: NEStackLayer.h:44
NEStackLayer()
Default constructor.