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.

146 lines
8.2 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::filter 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="a00053.html">filter</a></li> </ul>
  37. </div>
  38. </div><!-- top -->
  39. <div class="header">
  40. <div class="summary">
  41. <a href="#pro-static-attribs">Static Protected Attributes</a> &#124;
  42. <a href="a00268.html">List of all members</a> </div>
  43. <div class="headertitle">
  44. <div class="title">tbb::filter Class Reference<div class="ingroups"><a class="el" href="a00234.html">Algorithms</a></div></div> </div>
  45. </div><!--header-->
  46. <div class="contents">
  47. <p>A stage in a pipeline.
  48. <a href="a00053.html#details">More...</a></p>
  49. <p><code>#include &lt;pipeline.h&gt;</code></p>
  50. <div class="dynheader">
  51. Inheritance diagram for tbb::filter:</div>
  52. <div class="dyncontent">
  53. <div class="center">
  54. <img src="a00053.png" usemap="#tbb::filter_map" alt=""/>
  55. <map id="tbb::filter_map" name="tbb::filter_map">
  56. <area href="a00150.html" title="A stage in a pipeline served by a user thread. " alt="tbb::thread_bound_filter" shape="rect" coords="0,112,145,136"/>
  57. </map>
  58. </div></div>
  59. <table class="memberdecls">
  60. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-attribs"></a>
  61. Static Protected Attributes</h2></td></tr>
  62. <tr class="memitem:ae9dab2e01b0963b341ab04b59eec1475"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae9dab2e01b0963b341ab04b59eec1475"></a>
  63. static const unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00053.html#ae9dab2e01b0963b341ab04b59eec1475">filter_is_serial</a> = 0x1</td></tr>
  64. <tr class="memdesc:ae9dab2e01b0963b341ab04b59eec1475"><td class="mdescLeft">&#160;</td><td class="mdescRight">The lowest bit 0 is for parallel vs. serial. <br/></td></tr>
  65. <tr class="separator:ae9dab2e01b0963b341ab04b59eec1475"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. <tr class="memitem:a091fcf6abc79edfa5c8bf01f742e2392"><td class="memItemLeft" align="right" valign="top">static const unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00053.html#a091fcf6abc79edfa5c8bf01f742e2392">filter_is_out_of_order</a> = 0x1&lt;&lt;4</td></tr>
  67. <tr class="memdesc:a091fcf6abc79edfa5c8bf01f742e2392"><td class="mdescLeft">&#160;</td><td class="mdescRight">4th bit distinguishes ordered vs unordered filters. <a href="#a091fcf6abc79edfa5c8bf01f742e2392">More...</a><br/></td></tr>
  68. <tr class="separator:a091fcf6abc79edfa5c8bf01f742e2392"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69. <tr class="memitem:a1382f216bd094064a18eb48ecc43c86b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1382f216bd094064a18eb48ecc43c86b"></a>
  70. static const unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00053.html#a1382f216bd094064a18eb48ecc43c86b">filter_is_bound</a> = 0x1&lt;&lt;5</td></tr>
  71. <tr class="memdesc:a1382f216bd094064a18eb48ecc43c86b"><td class="mdescLeft">&#160;</td><td class="mdescRight">5th bit distinguishes thread-bound and regular filters. <br/></td></tr>
  72. <tr class="separator:a1382f216bd094064a18eb48ecc43c86b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:a6645ec56872b6ba2056dcaa467e292f7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6645ec56872b6ba2056dcaa467e292f7"></a>
  74. static const unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00053.html#a6645ec56872b6ba2056dcaa467e292f7">filter_may_emit_null</a> = 0x1&lt;&lt;6</td></tr>
  75. <tr class="memdesc:a6645ec56872b6ba2056dcaa467e292f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">6th bit marks input filters emitting small objects <br/></td></tr>
  76. <tr class="separator:a6645ec56872b6ba2056dcaa467e292f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:aab9689e23a96c6c9bf1c8caae74d92ee"><td class="memItemLeft" align="right" valign="top">static const unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00053.html#aab9689e23a96c6c9bf1c8caae74d92ee">exact_exception_propagation</a></td></tr>
  78. <tr class="memdesc:aab9689e23a96c6c9bf1c8caae74d92ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">7th bit defines exception propagation mode expected by the application. <a href="#aab9689e23a96c6c9bf1c8caae74d92ee">More...</a><br/></td></tr>
  79. <tr class="separator:aab9689e23a96c6c9bf1c8caae74d92ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. </table>
  81. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  82. <div class="textblock"><p>A stage in a pipeline. </p>
  83. </div><h2 class="groupheader">Member Data Documentation</h2>
  84. <a class="anchor" id="aab9689e23a96c6c9bf1c8caae74d92ee"></a>
  85. <div class="memitem">
  86. <div class="memproto">
  87. <table class="mlabels">
  88. <tr>
  89. <td class="mlabels-left">
  90. <table class="memname">
  91. <tr>
  92. <td class="memname">const unsigned char tbb::filter::exact_exception_propagation</td>
  93. </tr>
  94. </table>
  95. </td>
  96. <td class="mlabels-right">
  97. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
  98. </tr>
  99. </table>
  100. </div><div class="memdoc">
  101. <b>Initial value:</b><div class="fragment"><div class="line">=</div>
  102. <div class="line"><span class="preprocessor">#if TBB_USE_CAPTURED_EXCEPTION</span></div>
  103. <div class="line"><span class="preprocessor"> 0x0</span></div>
  104. </div><!-- fragment -->
  105. <p>7th bit defines exception propagation mode expected by the application. </p>
  106. </div>
  107. </div>
  108. <a class="anchor" id="a091fcf6abc79edfa5c8bf01f742e2392"></a>
  109. <div class="memitem">
  110. <div class="memproto">
  111. <table class="mlabels">
  112. <tr>
  113. <td class="mlabels-left">
  114. <table class="memname">
  115. <tr>
  116. <td class="memname">const unsigned char tbb::filter::filter_is_out_of_order = 0x1&lt;&lt;4</td>
  117. </tr>
  118. </table>
  119. </td>
  120. <td class="mlabels-right">
  121. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
  122. </tr>
  123. </table>
  124. </div><div class="memdoc">
  125. <p>4th bit distinguishes ordered vs unordered filters. </p>
  126. <p>The bit was not set for parallel filters in TBB 2.1 and earlier, but is_ordered() function always treats parallel filters as out of order. </p>
  127. </div>
  128. </div>
  129. <hr/>The documentation for this class was generated from the following file:<ul>
  130. <li>pipeline.h</li>
  131. </ul>
  132. </div><!-- contents -->
  133. <hr>
  134. <p></p>
  135. Copyright &copy; 2005-2014 Intel Corporation. All Rights Reserved.
  136. <p></p>
  137. Intel, Pentium, Intel Xeon, Itanium, Intel XScale and VTune are
  138. registered trademarks or trademarks of Intel Corporation or its
  139. subsidiaries in the United States and other countries.
  140. <p></p>
  141. * Other names and brands may be claimed as the property of others.