xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/graph/nodes/StackLayerNode.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2019 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_GRAPH_STACK_LAYER_NODE_H
25 #define ARM_COMPUTE_GRAPH_STACK_LAYER_NODE_H
26 
27 #include "arm_compute/graph/INode.h"
28 
29 namespace arm_compute
30 {
31 namespace graph
32 {
33 /** Stack Layer node */
34 class StackLayerNode final : public INode
35 {
36 public:
37     /** Constructor
38      *
39      * @param[in] total_nodes Number of nodes that will get stacked
40      * @param[in] axis        Axis alogn which to stack the input tensors
41      */
42     StackLayerNode(unsigned int total_nodes, int axis);
43     /** Computes stack output descriptor
44      *
45      * @param[in] input_descriptors Input descriptors
46      * @param[in] axis              Axis along which to stack the input tensors
47      *
48      * @return Expected output descriptor
49      */
50     static TensorDescriptor compute_output_descriptor(const std::vector<TensorDescriptor> &input_descriptors, int axis);
51     /** Stack axis parameter accessor
52      *
53      * @return Stack axis
54      */
55     int axis() const;
56 
57     // Inherited overridden methods:
58     NodeType         type() const override;
59     bool             forward_descriptors() override;
60     TensorDescriptor configure_output(size_t idx) const override;
61     void accept(INodeVisitor &v) override;
62 
63 private:
64     unsigned int _total_nodes;
65     int          _axis;
66 };
67 } // namespace graph
68 } // namespace arm_compute
69 #endif /* ARM_COMPUTE_GRAPH_STACK_LAYER_NODE_H */
70