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.

139 lines
9.8 KiB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.4"/>
  7. <title>tbb::pipeline Class Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. </head>
  13. <body>
  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15. <!-- end header part -->
  16. <!-- Generated by Doxygen 1.8.4 -->
  17. <div id="navrow1" class="tabs">
  18. <ul class="tablist">
  19. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  20. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  21. <li><a href="modules.html"><span>Modules</span></a></li>
  22. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  23. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  24. <li><a href="files.html"><span>Files</span></a></li>
  25. </ul>
  26. </div>
  27. <div id="navrow2" class="tabs2">
  28. <ul class="tablist">
  29. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  30. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  31. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  32. </ul>
  33. </div>
  34. <div id="nav-path" class="navpath">
  35. <ul>
  36. <li class="navelem"><a class="el" href="a00222.html">tbb</a></li><li class="navelem"><a class="el" href="a00089.html">pipeline</a></li> </ul>
  37. </div>
  38. </div><!-- top -->
  39. <div class="header">
  40. <div class="summary">
  41. <a href="#pub-methods">Public Member Functions</a> &#124;
  42. <a href="#friends">Friends</a> &#124;
  43. <a href="a00270.html">List of all members</a> </div>
  44. <div class="headertitle">
  45. <div class="title">tbb::pipeline Class Reference<div class="ingroups"><a class="el" href="a00234.html">Algorithms</a></div></div> </div>
  46. </div><!--header-->
  47. <div class="contents">
  48. <p>A processing pipeline that applies filters to items.
  49. <a href="a00089.html#details">More...</a></p>
  50. <p><code>#include &lt;pipeline.h&gt;</code></p>
  51. <table class="memberdecls">
  52. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  53. Public Member Functions</h2></td></tr>
  54. <tr class="memitem:afe7b7bd9b2617c2b69170675a478b2bd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afe7b7bd9b2617c2b69170675a478b2bd"></a>
  55. __TBB_EXPORTED_METHOD&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00089.html#afe7b7bd9b2617c2b69170675a478b2bd">pipeline</a> ()</td></tr>
  56. <tr class="memdesc:afe7b7bd9b2617c2b69170675a478b2bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct empty pipeline. <br/></td></tr>
  57. <tr class="separator:afe7b7bd9b2617c2b69170675a478b2bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  58. <tr class="memitem:ac3a7b33217b3f3bb0682ec3a40fd2c39"><td class="memItemLeft" align="right" valign="top">virtual __TBB_EXPORTED_METHOD&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00089.html#ac3a7b33217b3f3bb0682ec3a40fd2c39">~pipeline</a> ()</td></tr>
  59. <tr class="separator:ac3a7b33217b3f3bb0682ec3a40fd2c39"><td class="memSeparator" colspan="2">&#160;</td></tr>
  60. <tr class="memitem:a8eb83014bd53b184e0ed50f120ca310b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8eb83014bd53b184e0ed50f120ca310b"></a>
  61. void __TBB_EXPORTED_METHOD&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00089.html#a8eb83014bd53b184e0ed50f120ca310b">add_filter</a> (<a class="el" href="a00053.html">filter</a> &amp;filter_)</td></tr>
  62. <tr class="memdesc:a8eb83014bd53b184e0ed50f120ca310b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add filter to end of pipeline. <br/></td></tr>
  63. <tr class="separator:a8eb83014bd53b184e0ed50f120ca310b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64. <tr class="memitem:ac9ee9080cfc080c40a7ee7cb03a62637"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac9ee9080cfc080c40a7ee7cb03a62637"></a>
  65. void __TBB_EXPORTED_METHOD&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00089.html#ac9ee9080cfc080c40a7ee7cb03a62637">run</a> (size_t max_number_of_live_tokens)</td></tr>
  66. <tr class="memdesc:ac9ee9080cfc080c40a7ee7cb03a62637"><td class="mdescLeft">&#160;</td><td class="mdescRight">Run the pipeline to completion. <br/></td></tr>
  67. <tr class="separator:ac9ee9080cfc080c40a7ee7cb03a62637"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:a270dba81f7dd9935be7f3d69db907ff4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a270dba81f7dd9935be7f3d69db907ff4"></a>
  69. void __TBB_EXPORTED_METHOD&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00089.html#a270dba81f7dd9935be7f3d69db907ff4">run</a> (size_t max_number_of_live_tokens, <a class="el" href="a00138.html">tbb::task_group_context</a> &amp;context)</td></tr>
  70. <tr class="memdesc:a270dba81f7dd9935be7f3d69db907ff4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Run the pipeline to completion with user-supplied context. <br/></td></tr>
  71. <tr class="separator:a270dba81f7dd9935be7f3d69db907ff4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <tr class="memitem:ae53edbda1771eeaa254d78ae6100a762"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae53edbda1771eeaa254d78ae6100a762"></a>
  73. void __TBB_EXPORTED_METHOD&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00089.html#ae53edbda1771eeaa254d78ae6100a762">clear</a> ()</td></tr>
  74. <tr class="memdesc:ae53edbda1771eeaa254d78ae6100a762"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove all filters from the pipeline. <br/></td></tr>
  75. <tr class="separator:ae53edbda1771eeaa254d78ae6100a762"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. </table><table class="memberdecls">
  77. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  78. Friends</h2></td></tr>
  79. <tr class="memitem:a88bd11ed4d74f6de43a7d3b0bc05f2c3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a88bd11ed4d74f6de43a7d3b0bc05f2c3"></a>
  80. class&#160;</td><td class="memItemRight" valign="bottom"><b>internal::stage_task</b></td></tr>
  81. <tr class="separator:a88bd11ed4d74f6de43a7d3b0bc05f2c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:aa6f9dcf41617866d7bf0e72d8efc11e7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa6f9dcf41617866d7bf0e72d8efc11e7"></a>
  83. class&#160;</td><td class="memItemRight" valign="bottom"><b>internal::pipeline_root_task</b></td></tr>
  84. <tr class="separator:aa6f9dcf41617866d7bf0e72d8efc11e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:adcddbbe2df37193795a145ef8aac7954"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adcddbbe2df37193795a145ef8aac7954"></a>
  86. class&#160;</td><td class="memItemRight" valign="bottom"><b>filter</b></td></tr>
  87. <tr class="separator:adcddbbe2df37193795a145ef8aac7954"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:ab4463cf8612c362ee109224e45fad104"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab4463cf8612c362ee109224e45fad104"></a>
  89. class&#160;</td><td class="memItemRight" valign="bottom"><b>thread_bound_filter</b></td></tr>
  90. <tr class="separator:ab4463cf8612c362ee109224e45fad104"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:a39b28579343dc2cdb67fe3fbffe731a8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a39b28579343dc2cdb67fe3fbffe731a8"></a>
  92. class&#160;</td><td class="memItemRight" valign="bottom"><b>internal::pipeline_cleaner</b></td></tr>
  93. <tr class="separator:a39b28579343dc2cdb67fe3fbffe731a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a0307e203ca37529138734040c3881a35"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0307e203ca37529138734040c3881a35"></a>
  95. class&#160;</td><td class="memItemRight" valign="bottom"><b>tbb::interface6::internal::pipeline_proxy</b></td></tr>
  96. <tr class="separator:a0307e203ca37529138734040c3881a35"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. </table>
  98. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  99. <div class="textblock"><p>A processing pipeline that applies filters to items. </p>
  100. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  101. <a class="anchor" id="ac3a7b33217b3f3bb0682ec3a40fd2c39"></a>
  102. <div class="memitem">
  103. <div class="memproto">
  104. <table class="mlabels">
  105. <tr>
  106. <td class="mlabels-left">
  107. <table class="memname">
  108. <tr>
  109. <td class="memname">virtual __TBB_EXPORTED_METHOD tbb::pipeline::~pipeline </td>
  110. <td>(</td>
  111. <td class="paramname">)</td><td></td>
  112. <td></td>
  113. </tr>
  114. </table>
  115. </td>
  116. <td class="mlabels-right">
  117. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  118. </tr>
  119. </table>
  120. </div><div class="memdoc">
  121. <p>Though the current implementation declares the destructor virtual, do not rely on this detail. The virtualness is deprecated and may disappear in future versions of TBB. </p>
  122. </div>
  123. </div>
  124. <hr/>The documentation for this class was generated from the following file:<ul>
  125. <li>pipeline.h</li>
  126. </ul>
  127. </div><!-- contents -->
  128. <hr>
  129. <p></p>
  130. Copyright &copy; 2005-2014 Intel Corporation. All Rights Reserved.
  131. <p></p>
  132. Intel, Pentium, Intel Xeon, Itanium, Intel XScale and VTune are
  133. registered trademarks or trademarks of Intel Corporation or its
  134. subsidiaries in the United States and other countries.
  135. <p></p>
  136. * Other names and brands may be claimed as the property of others.