Compute Library
 21.05
SplitLayerNode.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_GRAPH_SPLIT_LAYER_NODE_H
25 #define ARM_COMPUTE_GRAPH_SPLIT_LAYER_NODE_H
26 
28 
29 #include <tuple>
30 
31 namespace arm_compute
32 {
33 namespace graph
34 {
35 /** Split Layer node */
36 class SplitLayerNode final : public INode
37 {
38 public:
39  /** Default Constructor
40  *
41  * @param[in] num_splits Number of splits
42  * @param[in] axis (Optional) Axis to split on. Defaults to 0
43  * @param[in] size_splits (Optional) The sizes of each output tensor along the split dimension.
44  * Must sum to the dimension of value along split_dim.
45  * Can contain one -1 indicating that dimension is to be inferred.
46  */
47  SplitLayerNode(unsigned int num_splits, int axis = 0, std::vector<int> size_splits = std::vector<int>());
48  /** Computes split layer output descriptor
49  *
50  * @param[in] input_descriptor Descriptor of the input tensor
51  * @param[in] num_splits Number of splits
52  * @param[in] axis Axis to perform the split on
53  * @param[in] idx Index of the split
54  *
55  * @return A pair with the descriptor of the split and the starting coordinates
56  */
57  std::pair<TensorDescriptor, Coordinates> compute_output_descriptor(const TensorDescriptor &input_descriptor,
58  unsigned int num_splits, int axis, unsigned int idx);
59  /** Number of splits accessor
60  *
61  * @return Number of splits
62  */
63  unsigned int num_splits() const;
64  /** Split axis accessor
65  *
66  * @return Split axis
67  */
68  unsigned int axis() const;
69 
70  // Inherited overridden methods:
71  Status validate() const override;
72  NodeType type() const override;
73  bool forward_descriptors() override;
74  TensorDescriptor configure_output(size_t idx) const override;
75  void accept(INodeVisitor &v) override;
76 
77 private:
78  unsigned int _num_splits;
79  int _axis;
80  std::vector<int> _size_splits;
81 };
82 } // namespace graph
83 } // namespace arm_compute
84 #endif /* ARM_COMPUTE_GRAPH_SPLIT_LAYER_NODE_H */
NodeType type() const override
Returns node's type.
Status class.
Definition: Error.h:52
unsigned int num_splits() const
Number of splits accessor.
Copyright (c) 2017-2021 Arm Limited.
Node interface.
Definition: INode.h:45
NodeType
Supported nodes.
Definition: Types.h:148
unsigned int axis() const
Split axis accessor.
SplitLayerNode(unsigned int num_splits, int axis=0, std::vector< int > size_splits=std::vector< int >())
Default Constructor.
void accept(INodeVisitor &v) override
Accepts a node visitor.
std::pair< TensorDescriptor, Coordinates > compute_output_descriptor(const TensorDescriptor &input_descriptor, unsigned int num_splits, int axis, unsigned int idx)
Computes split layer output descriptor.
bool forward_descriptors() override
Forwards descriptor information to outputs if possible.
Node visitor interface.
Definition: INodeVisitor.h:34
Status validate() const override
Validate node.
TensorDescriptor configure_output(size_t idx) const override
Calculates output configuration.