Compute Library
 22.11
IStream.h
Go to the documentation of this file.
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_ISTREAM_H
25 #define ARM_COMPUTE_GRAPH_ISTREAM_H
26 
28 
29 namespace arm_compute
30 {
31 namespace graph
32 {
33 // Forward declarations
34 class Graph;
35 
36 namespace frontend
37 {
38 // Forward declarations
39 class ILayer;
40 
41 /** Stream interface **/
42 class IStream
43 {
44 public:
45  virtual ~IStream() = default;
46  /** Adds a layer to the stream
47  *
48  * @param[in] layer Layer to add
49  */
50  virtual void add_layer(ILayer &layer) = 0;
51  /** Returns the underlying graph
52  *
53  * @return Underlying graph
54  */
55  virtual Graph &graph() = 0;
56  /** Returns the underlying graph
57  *
58  * @return Underlying graph
59  */
60  virtual const Graph &graph() const = 0;
61  /** Returns the tail node of the Stream
62  *
63  * @return Tail Node ID
64  */
66  {
67  return _tail_node;
68  }
69  /** Returns the stream hints that are currently used
70  *
71  * @return Stream hints
72  */
74  {
75  return _hints;
76  }
77  /** Forwards tail of stream to a given nid
78  *
79  * @param[in] nid NodeID of the updated tail node
80  */
81  void forward_tail(NodeID nid)
82  {
83  _tail_node = (nid != NullTensorID) ? nid : _tail_node;
84  }
85 
86 protected:
87  StreamHints _hints = {}; /**< Execution and algorithmic hints */
88  NodeID _tail_node = { EmptyNodeID }; /**< NodeID pointing to the last(tail) node of the graph */
89 };
90 } // namespace frontend
91 } // namespace graph
92 } // namespace arm_compute
93 #endif /* ARM_COMPUTE_GRAPH_ISTREAM_H */
Hints that can be passed to the stream to expose parameterization.
Definition: Types.h:61
Copyright (c) 2017-2022 Arm Limited.
virtual void add_layer(ILayer &layer)=0
Adds a layer to the stream.
NodeID tail_node()
Returns the tail node of the Stream.
Definition: IStream.h:65
void forward_tail(NodeID nid)
Forwards tail of stream to a given nid.
Definition: IStream.h:81
Graph class.
Definition: Graph.h:53
unsigned int NodeID
Definition: Types.h:69
virtual Graph & graph()=0
Returns the underlying graph.
StreamHints & hints()
Returns the stream hints that are currently used.
Definition: IStream.h:73
constexpr NodeID EmptyNodeID
Constant EdgeID specifying an equivalent of null edge.
Definition: Types.h:76
constexpr TensorID NullTensorID
Constant NodeID specifying an equivalent of null node.
Definition: Types.h:74