xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/graph/nodes/ConcatenateLayerNode.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2018-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_CONCATENATE_LAYER_NODE_H
25 #define ARM_COMPUTE_GRAPH_CONCATENATE_LAYER_NODE_H
26 
27 #include "arm_compute/graph/INode.h"
28 
29 namespace arm_compute
30 {
31 namespace graph
32 {
33 /** Concatenation Layer node */
34 class ConcatenateLayerNode final : public INode
35 {
36 public:
37     /** Constructor
38      *
39      * @param[in] total_nodes       Number of nodes that will get concatenated
40      * @param[in] concat_descriptor Concatenate Layer Descriptor
41      */
42     ConcatenateLayerNode(unsigned int total_nodes, descriptors::ConcatLayerDescriptor concat_descriptor);
43     /** Computes concatenations output descriptor
44      *
45      * @param[in] input_descriptors Input descriptors
46      * @param[in] axis              Concatenation axis
47      *
48      * @return Expected output descriptor
49      */
50     static TensorDescriptor compute_output_descriptor(const std::vector<TensorDescriptor> &input_descriptors, DataLayoutDimension axis);
51     /** Disables or not the depth concatenate node
52      *
53      * @warning This is used when concatenate is performed using sub-tensors, where this node is used as a placeholder.
54      *
55      * @param[in] is_enabled If true a backend function is created to perform the concatenation (involves copying),
56      *                       while if false, no function is created and we assume that sub-tensors are properly set to simulate
57      *                       a zero copy operation.
58      */
59     void set_enabled(bool is_enabled);
60     /** Enabled parameter accessor
61      *
62      * @return True if a backend function is to be created else false
63      */
64     bool is_enabled() const;
65     /** Concatenation axis parameter accessor
66      *
67      * @return Concatenation axis
68      */
69     DataLayoutDimension concatenation_axis() const;
70 
71     /** Concatenation output quantization info accessor
72      *
73      * @return Output quantization info
74      */
75     QuantizationInfo output_quantization_info() const;
76 
77     // Inherited overridden methods:
78     NodeType         type() const override;
79     bool             forward_descriptors() override;
80     TensorDescriptor configure_output(size_t idx) const override;
81     void accept(INodeVisitor &v) override;
82 
83 private:
84     unsigned int                       _total_nodes;
85     descriptors::ConcatLayerDescriptor _concat_descriptor;
86     bool                               _is_enabled;
87 };
88 } // namespace graph
89 } // namespace arm_compute
90 #endif /* ARM_COMPUTE_GRAPH_CONCATENATE_LAYER_NODE_H */
91