1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
|
<!DOCTYPE html
PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- saved from url=(0014)about:internet -->
<html xmlns:MSHelp="http://www.microsoft.com/MSHelp/" lang="en-us" xml:lang="en-us"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="DC.Type" content="reference">
<meta name="DC.Title" content="split_node Template Class">
<meta name="DC.subject" content="split_node Template Class">
<meta name="keywords" content="split_node Template Class">
<meta name="DC.Relation" scheme="URI" content="../../reference/flow_graph.htm">
<meta name="DC.Relation" scheme="URI" content="flow_tuple.htm#flow_tuple">
<meta name="DC.Format" content="XHTML">
<meta name="DC.Identifier" content="split_node_cls">
<meta name="DC.Language" content="en-US">
<link rel="stylesheet" type="text/css" href="../../intel_css_styles.css">
<title>split_node Template Class</title>
<xml>
<MSHelp:Attr Name="DocSet" Value="Intel"></MSHelp:Attr>
<MSHelp:Attr Name="Locale" Value="kbEnglish"></MSHelp:Attr>
<MSHelp:Attr Name="TopicType" Value="kbReference"></MSHelp:Attr>
</xml>
</head>
<body id="split_node_cls">
<!-- ==============(Start:NavScript)================= -->
<script src="..\..\NavScript.js" language="JavaScript1.2" type="text/javascript"></script>
<script language="JavaScript1.2" type="text/javascript">WriteNavLink(2);</script>
<!-- ==============(End:NavScript)================= -->
<a name="split_node_cls"><!-- --></a>
<h1 class="topictitle1">split_node Template Class</h1>
<div>
<div class="section"><h2 class="sectiontitle">Summary</h2>
<p>A template class that is a
<samp class="codeph">receiver<TupleType></samp> and has a
tuple of
<samp class="codeph">sender< tuple_element< i,
TupleType >::type ></samp> output ports; where i is the index in the
tuple. A
<samp class="codeph">split_node</samp> sends each
element of the incoming tuple to the output port that matches the element's
index in the incoming tuple. This node has unlimited concurrency.
</p>
</div>
<div class="section"><h2 class="sectiontitle">Syntax</h2>
<pre>template < typename TupleType >
class split_node;</pre>
</div>
<div class="section"><h2 class="sectiontitle">Header</h2>
<pre>#include "tbb/flow_graph.h"</pre>
</div>
<div class="section"><h2 class="sectiontitle">Description</h2>
<p>This node receives a tuple at its single input port
and generates a message from each element of the tuple, passing each to the
corresponding output port.
</p>
<p>A
<samp class="codeph">split_node</samp> has
unlimited concurrency, no buffering, and behaves as a
<samp class="codeph">broadcast_node</samp> with
multiple output ports.
</p>
</div>
<div class="section"><h2 class="sectiontitle">Example</h2>
<p>The example below shows a
<samp class="codeph">split_node</samp> that
separates a stream of tuples of integers, placing each element of the tuple in
the appropriate output queue.
</p>
<p>The output ports of the
<samp class="codeph">split_node</samp> can be
connected to other graph nodes using the
<samp class="codeph">make_edge</samp> method or by
using
<samp class="codeph">register_successor</samp>:
</p>
<pre>#include "tbb/flow_graph.h"
using namespace tbb::flow;
int main() {
graph g;
queue_node<int> first_queue(g);
queue_node<int> second_queue(g);
split_node< flow::tuple<int,int> > my_split_node(g);
output_port<0>(my_split_node).register_successor(first_queue);
make_edge(output_port<1>(my_split_node), second_queue);
for(int i = 0; i < 1000; ++i) {
node1.try_put(int_tuple_type(2*i,2*i+1));
}
g.wait_for_all();
}</pre>
</div>
<div class="section"><h2 class="sectiontitle">Members</h2>
<pre>namespace tbb {
template < typename TupleType >
class split_node : public graph_node, public receiver<TupleType>
{
public:
split_node( graph &g );
split_node( const split_node &other);
~split_node();
// receiver< TupleType >
typedef TupleType input_type;
typedef sender<input_type> predecessor_type;
bool try_put( const input_type &v );
bool register_predecessor( predecessor_type &p );
bool remove_predecessor( predecessor_type &p );
typedef <em>implementation-dependent</em> output_ports_type;
output_ports_type& output_ports();
};
}</pre>
<div class="tablenoborder"><table cellpadding="4" summary="" frame="border" border="1" cellspacing="0" rules="all"><span class="tabledesc">The following table provides additional information on the
members of this template class.
</span><thead align="left">
<tr>
<th class="cellrowborder" valign="top" width="33.89830508474576%" id="d86984e129">Member
</th>
<th class="cellrowborder" valign="top" width="66.10169491525423%" id="d86984e132">Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td class="cellrowborder" valign="top" width="33.89830508474576%" headers="d86984e129 ">
<span class="keyword">split_node( graph &g )</span>
</td>
<td class="cellrowborder" valign="top" width="66.10169491525423%" headers="d86984e132 ">
<p>Constructs a
<span class="keyword">split_node</span> registered with graph
<span class="keyword">g</span>.
</p>
</td>
</tr>
<tr>
<td class="cellrowborder" valign="top" width="33.89830508474576%" headers="d86984e129 ">
<span class="keyword">split_node( const split_node &other)</span>
</td>
<td class="cellrowborder" valign="top" width="66.10169491525423%" headers="d86984e132 ">
<p>Constructs a
<span class="keyword">split_node</span> that has the same initial state
that
<span class="keyword">other</span> had when it was constructed. The
<span class="keyword">split_node</span> that is constructed will have a
reference to the same
<span class="keyword">graph</span> object as
<span class="keyword">other</span>. The predecessors and successors of
<span class="keyword">other</span> will not be copied.
</p>
</td>
</tr>
<tr>
<td class="cellrowborder" valign="top" width="33.89830508474576%" headers="d86984e129 ">
<span class="keyword">~split_node()</span>
</td>
<td class="cellrowborder" valign="top" width="66.10169491525423%" headers="d86984e132 ">
<p>Destructor
</p>
</td>
</tr>
<tr>
<td class="cellrowborder" valign="top" width="33.89830508474576%" headers="d86984e129 ">
<span class="keyword">bool try_put( const input_type &v )</span>
</td>
<td class="cellrowborder" valign="top" width="66.10169491525423%" headers="d86984e132 ">
<p>Broadcasts each element of the incoming tuple to the nodes
connected to the
<span class="keyword">split_node</span>'s output ports. The element at
index
<span class="keyword">i</span> of
<span class="keyword">v</span>i will be broadcast through the
<span class="keyword">i</span>th output port.
</p>
<p><strong>Returns</strong>:
<span class="keyword">true</span>
</p>
</td>
</tr>
<tr>
<td class="cellrowborder" valign="top" width="33.89830508474576%" headers="d86984e129 "><span class="keyword">bool register_predecessor(
predecessor_type &p )</span>
</td>
<td class="cellrowborder" valign="top" width="66.10169491525423%" headers="d86984e132 ">
<p>Adds
<span class="keyword">p</span> to the set of predecessors.
</p>
<p><strong>Returns</strong>:
<span class="keyword">true</span>
</p>
</td>
</tr>
<tr>
<td class="cellrowborder" valign="top" width="33.89830508474576%" headers="d86984e129 "><span class="keyword">bool remove_predecessor(
predecessor_type &p )</span>
</td>
<td class="cellrowborder" valign="top" width="66.10169491525423%" headers="d86984e132 ">
<p>Removes
<span class="keyword">p</span> from the set of predecessors.
</p>
<p><strong>Returns</strong>:
<span class="keyword">true</span>
</p>
</td>
</tr>
<tr>
<td class="cellrowborder" valign="top" width="33.89830508474576%" headers="d86984e129 "><span class="keyword">output_ports_type&
output_ports();</span>
</td>
<td class="cellrowborder" valign="top" width="66.10169491525423%" headers="d86984e132 ">
<p><strong>Returns</strong>: a tuple of output ports.
</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="../../reference/flow_graph.htm">Flow Graph</a></div>
</div>
<div class="See Also">
<h2>See Also</h2>
<div class="linklist">
<div><a href="flow_tuple.htm#flow_tuple">flow::tuple Template Class
</a></div></div>
</div>
</body>
</html>
|
