You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
165 lines
8.9 KiB
165 lines
8.9 KiB
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.4"/>
|
|
<title>tbb::parallel_while< Body > Class Template Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.4 -->
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="a00222.html">tbb</a></li><li class="navelem"><a class="el" href="a00088.html">parallel_while</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="a00267.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">tbb::parallel_while< Body > Class Template Reference<div class="ingroups"><a class="el" href="a00234.html">Algorithms</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Parallel iteration over a stream, with optional addition of more work.
|
|
<a href="a00088.html#details">More...</a></p>
|
|
|
|
<p><code>#include <parallel_while.h></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for tbb::parallel_while< Body >:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="a00088.png" usemap="#tbb::parallel_while< Body >_map" alt=""/>
|
|
<map id="tbb::parallel_while< Body >_map" name="tbb::parallel_while< Body >_map">
|
|
</map>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:a2442f019427e608d46801376267e44a8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2442f019427e608d46801376267e44a8"></a>
|
|
typedef Body::argument_type </td><td class="memItemRight" valign="bottom"><a class="el" href="a00088.html#a2442f019427e608d46801376267e44a8">value_type</a></td></tr>
|
|
<tr class="memdesc:a2442f019427e608d46801376267e44a8"><td class="mdescLeft"> </td><td class="mdescRight">Type of items. <br/></td></tr>
|
|
<tr class="separator:a2442f019427e608d46801376267e44a8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a220a7307358aa36802c8754ea45ca385"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a220a7307358aa36802c8754ea45ca385"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="a00088.html#a220a7307358aa36802c8754ea45ca385">parallel_while</a> ()</td></tr>
|
|
<tr class="memdesc:a220a7307358aa36802c8754ea45ca385"><td class="mdescLeft"> </td><td class="mdescRight">Construct empty non-running parallel while. <br/></td></tr>
|
|
<tr class="separator:a220a7307358aa36802c8754ea45ca385"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac2fd559c8a38639fa1ba97a0d5639ca8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac2fd559c8a38639fa1ba97a0d5639ca8"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="a00088.html#ac2fd559c8a38639fa1ba97a0d5639ca8">~parallel_while</a> ()</td></tr>
|
|
<tr class="memdesc:ac2fd559c8a38639fa1ba97a0d5639ca8"><td class="mdescLeft"> </td><td class="mdescRight">Destructor cleans up data members before returning. <br/></td></tr>
|
|
<tr class="separator:ac2fd559c8a38639fa1ba97a0d5639ca8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a20607ba5faa958144787d980aa850c16"><td class="memTemplParams" colspan="2">template<typename Stream > </td></tr>
|
|
<tr class="memitem:a20607ba5faa958144787d980aa850c16"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00088.html#a20607ba5faa958144787d980aa850c16">run</a> (Stream &stream, const Body &body)</td></tr>
|
|
<tr class="memdesc:a20607ba5faa958144787d980aa850c16"><td class="mdescLeft"> </td><td class="mdescRight">Apply body.apply to each item in the stream. <a href="#a20607ba5faa958144787d980aa850c16">More...</a><br/></td></tr>
|
|
<tr class="separator:a20607ba5faa958144787d980aa850c16"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4861989d7f5e3111d264d4d6013e8fe1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00088.html#a4861989d7f5e3111d264d4d6013e8fe1">add</a> (const <a class="el" href="a00088.html#a2442f019427e608d46801376267e44a8">value_type</a> &item)</td></tr>
|
|
<tr class="memdesc:a4861989d7f5e3111d264d4d6013e8fe1"><td class="mdescLeft"> </td><td class="mdescRight">Add a work item while running. <a href="#a4861989d7f5e3111d264d4d6013e8fe1">More...</a><br/></td></tr>
|
|
<tr class="separator:a4861989d7f5e3111d264d4d6013e8fe1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><h3>template<typename Body><br/>
|
|
class tbb::parallel_while< Body ></h3>
|
|
|
|
<p>Parallel iteration over a stream, with optional addition of more work. </p>
|
|
<p>The Body b has the requirement: <br/>
|
|
"b(v)" <br/>
|
|
"b.argument_type" <br/>
|
|
where v is an argument_type </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a4861989d7f5e3111d264d4d6013e8fe1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Body > </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="a00088.html">tbb::parallel_while</a>< Body >::add </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="a00088.html#a2442f019427e608d46801376267e44a8">value_type</a> & </td>
|
|
<td class="paramname"><em>item</em>)</td><td></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Add a work item while running. </p>
|
|
<p>Should be executed only by body.apply or a thread spawned therefrom. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a20607ba5faa958144787d980aa850c16"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename Body > </div>
|
|
<div class="memtemplate">
|
|
template<typename Stream > </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="a00088.html">tbb::parallel_while</a>< Body >::run </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Stream & </td>
|
|
<td class="paramname"><em>stream</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const Body & </td>
|
|
<td class="paramname"><em>body</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Apply body.apply to each item in the stream. </p>
|
|
<p>A Stream s has the requirements <br/>
|
|
"S::value_type" <br/>
|
|
"s.pop_if_present(value) is convertible to bool </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>parallel_while.h</li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<hr>
|
|
<p></p>
|
|
Copyright © 2005-2014 Intel Corporation. All Rights Reserved.
|
|
<p></p>
|
|
Intel, Pentium, Intel Xeon, Itanium, Intel XScale and VTune are
|
|
registered trademarks or trademarks of Intel Corporation or its
|
|
subsidiaries in the United States and other countries.
|
|
<p></p>
|
|
* Other names and brands may be claimed as the property of others.
|