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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
|
<!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="overwrite_node Template Class">
<meta name="DC.subject" content="overwrite_node Template Class">
<meta name="keywords" content="overwrite_node Template Class">
<meta name="DC.Relation" scheme="URI" content="../../reference/flow_graph.htm">
<meta name="DC.Relation" scheme="URI" content="message_passing_protocol.htm">
<meta name="DC.Format" content="XHTML">
<meta name="DC.Identifier" content="overwrite_node_cls">
<meta name="DC.Language" content="en-US">
<link rel="stylesheet" type="text/css" href="../../intel_css_styles.css">
<title>overwrite_node Template Class</title>
</head>
<body id="overwrite_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="overwrite_node_cls"><!-- --></a>
<h1 class="topictitle1">overwrite_node Template Class</h1>
<div>
<div class="section"><h2 class="sectiontitle">Summary</h2>
<p>A template class that is a
<span class="keyword">graph_node</span>,
<span class="keyword">receiver<Input></span> and
<span class="keyword">sender<Output></span>. An
<span class="keyword">overwrite_node</span> is a buffer of a single item that can
be over-written. The value held in the buffer is initially invalid. Gets from
the node are non-destructive.
</p>
</div>
<div class="section"><h2 class="sectiontitle">Syntax</h2>
<pre>template < typename T > class overwrite_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 type of node buffers a single item of type T. The value is
initially invalid. A
<span class="keyword">try_put</span> will set the value of the internal buffer,
and broadcast the new value to all successors. If the internal value is valid,
a
<span class="keyword">try_get</span> will return
<span class="keyword">true</span> and copy the buffer value to the output. If the
internal value is invalid,
<span class="keyword">try_get</span> will return
<span class="keyword">false</span>.
</p>
<p>Rejection of messages by successors is handled using the protocol in
the Message Passage Protocol, see link below.
</p>
<p><span class="keyword">T</span> must be copy-constructible and assignable
</p>
</div>
<div class="section"><h2 class="sectiontitle">Members</h2>
<pre>namespace tbb {
namespace flow {
template< typename T >
class overwrite_node :
public graph_node, public receiver<T>,
public sender<T> {
public:
overwrite_node( graph &g );
overwrite_node( const overwrite_node &src );
~overwrite_node();
// receiver<T>
typedef T 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 );
// sender<T>
typedef T output_type;
typedef receiver<output_type> successor_type;
bool register_successor( successor_type &r );
bool remove_successor( successor_type &r );
bool try_get( output_type &v );
bool try_reserve( output_type &v );
bool try_release( );
bool try_consume( );
bool is_valid( );
void clear( );
};
}
}</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="d78590e178">Member
</th>
<th class="cellrowborder" valign="top" width="66.10169491525423%" id="d78590e181">Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td class="cellrowborder" valign="top" width="33.89830508474576%" headers="d78590e178 "><span class="keyword">overwrite_node( graph &g
)</span>
</td>
<td class="cellrowborder" valign="top" width="66.10169491525423%" headers="d78590e181 ">
<p>Constructs an object of type
<span class="keyword">overwrite_node</span> with an invalid internal
buffer item.
</p>
</td>
</tr>
<tr>
<td class="cellrowborder" valign="top" width="33.89830508474576%" headers="d78590e178 "><span class="keyword">overwrite_node( const
overwrite_node &src )</span>
</td>
<td class="cellrowborder" valign="top" width="66.10169491525423%" headers="d78590e181 ">
<p>Constructs an object of type
<span class="keyword">overwrite_node</span> that belongs to the
<span class="keyword">graph g</span> with an invalid internal buffer
item. The buffered value and list of successors is NOT copied from
<span class="keyword">src</span>.
</p>
</td>
</tr>
<tr>
<td class="cellrowborder" valign="top" width="33.89830508474576%" headers="d78590e178 "><span class="keyword">~overwrite_node( )</span>
</td>
<td class="cellrowborder" valign="top" width="66.10169491525423%" headers="d78590e181 ">
<p>Destroys the
<span class="keyword">overwrite_node</span>.
</p>
</td>
</tr>
<tr>
<td class="cellrowborder" valign="top" width="33.89830508474576%" headers="d78590e178 "><span class="keyword">bool try_put( const input_type
&v )</span>
</td>
<td class="cellrowborder" valign="top" width="66.10169491525423%" headers="d78590e181 ">
<p>Stores
<span class="keyword">v</span> in the internal single item buffer if it
does not already contain a valid value. If a new value is set, it calls
<span class="keyword">try_put(v)</span> on all successors.
</p>
<p><strong>Returns</strong>:
<span class="keyword">true</span>
</p>
</td>
</tr>
<tr>
<td class="cellrowborder" valign="top" width="33.89830508474576%" headers="d78590e178 "><span class="keyword">bool register_predecessor(
predecessor_type &p )</span>
</td>
<td class="cellrowborder" valign="top" width="66.10169491525423%" headers="d78590e181 ">
<p>Never rejects puts and therefore does not need to maintain a
list of predecessors.
</p>
<p><strong>Returns</strong>:
<span class="keyword">false</span>
</p>
</td>
</tr>
<tr>
<td class="cellrowborder" valign="top" width="33.89830508474576%" headers="d78590e178 "><span class="keyword">bool remove_predecessor(
predecessor_type &p )</span>
</td>
<td class="cellrowborder" valign="top" width="66.10169491525423%" headers="d78590e181 ">
<p>Never rejects puts and therefore does not need to maintain a
list of predecessors.
</p>
<p><strong>Returns</strong>:
<span class="keyword">false</span>
</p>
</td>
</tr>
<tr>
<td class="cellrowborder" valign="top" width="33.89830508474576%" headers="d78590e178 "><span class="keyword">bool register_successor(
successor_type &r )</span>
</td>
<td class="cellrowborder" valign="top" width="66.10169491525423%" headers="d78590e181 ">
<p>Adds
<span class="keyword">r</span> to the set of successors. If a valid
item
<span class="keyword">v</span> is held in the buffer, a task is
spawned to call
<span class="keyword">r.try_put(v)</span>.
</p>
<strong>Returns</strong>:
<span class="keyword">true</span>
</td>
</tr>
<tr>
<td class="cellrowborder" valign="top" width="33.89830508474576%" headers="d78590e178 "><span class="keyword">bool remove_successor(
successor_type &r )</span>
</td>
<td class="cellrowborder" valign="top" width="66.10169491525423%" headers="d78590e181 ">
<p>Removes
<span class="keyword">r</span> from the set of successors.
</p>
<p><strong>Returns</strong>:
<span class="keyword">true</span>
</p>
</td>
</tr>
<tr>
<td class="cellrowborder" valign="top" width="33.89830508474576%" headers="d78590e178 "><span class="keyword">bool try_get( output_type &v
)</span>
</td>
<td class="cellrowborder" valign="top" width="66.10169491525423%" headers="d78590e181 ">
<p>If the internal buffer is valid, assigns the value to
<span class="keyword">v</span>.
</p>
<p><strong>Returns</strong>:<span class="keyword">true</span> if
<span class="keyword">v</span> is assigned to.
<span class="keyword">false</span> if
<span class="keyword">v</span> is not assigned to.
</p>
</td>
</tr>
<tr>
<td class="cellrowborder" valign="top" width="33.89830508474576%" headers="d78590e178 "><span class="keyword">bool try_reserve( output_type
&v )
</span>
</td>
<td class="cellrowborder" valign="top" width="66.10169491525423%" headers="d78590e181 ">
<p>Does not support reservations.
</p>
<p><strong>Returns</strong>:
<span class="keyword">false</span>
</p>
</td>
</tr>
<tr>
<td class="cellrowborder" valign="top" width="33.89830508474576%" headers="d78590e178 "><span class="keyword">bool try_release( output_type
&v )
</span>
</td>
<td class="cellrowborder" valign="top" width="66.10169491525423%" headers="d78590e181 ">
<p>Does not support reservations.
</p>
<p><strong>Returns</strong>:
<span class="keyword">false</span>
</p>
</td>
</tr>
<tr>
<td class="cellrowborder" valign="top" width="33.89830508474576%" headers="d78590e178 "><span class="keyword">bool try_consume( output_type
&v )
</span>
<p>
</p>
</td>
<td class="cellrowborder" valign="top" width="66.10169491525423%" headers="d78590e181 ">
<p>Does not support reservations.
</p>
<p><strong>Returns</strong>:
<span class="keyword">false</span>
</p>
</td>
</tr>
<tr>
<td class="cellrowborder" valign="top" width="33.89830508474576%" headers="d78590e178 "><span class="keyword">bool is_valid( )</span>
</td>
<td class="cellrowborder" valign="top" width="66.10169491525423%" headers="d78590e181 ">
<p><strong>Returns</strong>:
<span class="keyword">true</span> if the buffer holds a valid value,
otherwise returns
<span class="keyword">false</span>.
</p>
</td>
</tr>
<tr>
<td class="cellrowborder" valign="top" width="33.89830508474576%" headers="d78590e178 "><span class="keyword">void clear( )</span>
</td>
<td class="cellrowborder" valign="top" width="66.10169491525423%" headers="d78590e181 ">
<p>Invalidates the value held in the buffer.
</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="message_passing_protocol.htm">Message Passing Protocol
</a></div></div>
</div>
</body>
</html>
|
