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.

224 lines
13 KiB

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
  2. <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
  3. <title>tbb::blocked_range&lt; Value &gt; Class Template Reference</title>
  4. <link href="doxygen.css" rel="stylesheet" type="text/css">
  5. <link href="tabs.css" rel="stylesheet" type="text/css">
  6. </head><body>
  7. <!-- Generated by Doxygen 1.4.7 -->
  8. <div class="tabs">
  9. <ul>
  10. <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  11. <li><a href="modules.html"><span>Modules</span></a></li>
  12. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  13. <li id="current"><a href="annotated.html"><span>Classes</span></a></li>
  14. <li><a href="files.html"><span>Files</span></a></li>
  15. <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  16. </ul></div>
  17. <div class="tabs">
  18. <ul>
  19. <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
  20. <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
  21. <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  22. </ul></div>
  23. <div class="nav">
  24. <a class="el" href="a00428.html">tbb</a>::<a class="el" href="a00271.html">blocked_range</a></div>
  25. <h1>tbb::blocked_range&lt; Value &gt; Class Template Reference<br>
  26. <small>
  27. [<a class="el" href="a00441.html">Algorithms</a>]</small>
  28. </h1><!-- doxytag: class="tbb::blocked_range" -->A range over which to iterate.
  29. <a href="#_details">More...</a>
  30. <p>
  31. <code>#include &lt;blocked_range.h&gt;</code>
  32. <p>
  33. <a href="a00010.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
  34. <tr><td></td></tr>
  35. <tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
  36. <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef Value&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00271.html#1a8d05842c2b3dfc177bc4d347e4cef7">const_iterator</a></td></tr>
  37. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Type of a value. <a href="#1a8d05842c2b3dfc177bc4d347e4cef7"></a><br></td></tr>
  38. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f5707bffea38eee5c9680f37358afb8e"></a><!-- doxytag: member="tbb::blocked_range::size_type" ref="f5707bffea38eee5c9680f37358afb8e" args="" -->
  39. typedef std::size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00271.html#f5707bffea38eee5c9680f37358afb8e">size_type</a></td></tr>
  40. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Type for size of a range. <br></td></tr>
  41. <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
  42. <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00271.html#94607755c5110d199202234d58d022ac">blocked_range</a> ()</td></tr>
  43. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct range with default-constructed values for begin and end. <a href="#94607755c5110d199202234d58d022ac"></a><br></td></tr>
  44. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="14795a36ead1414b4371dbe1a4656359"></a><!-- doxytag: member="tbb::blocked_range::blocked_range" ref="14795a36ead1414b4371dbe1a4656359" args="(Value begin_, Value end_, size_type grainsize_=1)" -->
  45. &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00271.html#14795a36ead1414b4371dbe1a4656359">blocked_range</a> (Value begin_, Value end_, <a class="el" href="a00271.html#f5707bffea38eee5c9680f37358afb8e">size_type</a> grainsize_=1)</td></tr>
  46. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct range over half-open interval [begin,end), with the given grainsize. <br></td></tr>
  47. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="18d2258400756ac1446dac7676b18df3"></a><!-- doxytag: member="tbb::blocked_range::begin" ref="18d2258400756ac1446dac7676b18df3" args="() const " -->
  48. <a class="el" href="a00271.html#1a8d05842c2b3dfc177bc4d347e4cef7">const_iterator</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00271.html#18d2258400756ac1446dac7676b18df3">begin</a> () const </td></tr>
  49. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Beginning of range. <br></td></tr>
  50. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8b929d93ddc13f148b11bceef3a3bdf8"></a><!-- doxytag: member="tbb::blocked_range::end" ref="8b929d93ddc13f148b11bceef3a3bdf8" args="() const " -->
  51. <a class="el" href="a00271.html#1a8d05842c2b3dfc177bc4d347e4cef7">const_iterator</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00271.html#8b929d93ddc13f148b11bceef3a3bdf8">end</a> () const </td></tr>
  52. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">One past last value in range. <br></td></tr>
  53. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00271.html#f5707bffea38eee5c9680f37358afb8e">size_type</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00271.html#9eaa0b6beff1420f688570bbf6b8c462">size</a> () const </td></tr>
  54. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Size of the range. <a href="#9eaa0b6beff1420f688570bbf6b8c462"></a><br></td></tr>
  55. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fcd2e5b8b6c11fd3f20fc0aa9f11bbc2"></a><!-- doxytag: member="tbb::blocked_range::grainsize" ref="fcd2e5b8b6c11fd3f20fc0aa9f11bbc2" args="() const " -->
  56. <a class="el" href="a00271.html#f5707bffea38eee5c9680f37358afb8e">size_type</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00271.html#fcd2e5b8b6c11fd3f20fc0aa9f11bbc2">grainsize</a> () const </td></tr>
  57. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The grain size for this range. <br></td></tr>
  58. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8f4f02f530eb3f2e7ea26e06f76aef9d"></a><!-- doxytag: member="tbb::blocked_range::empty" ref="8f4f02f530eb3f2e7ea26e06f76aef9d" args="() const " -->
  59. bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00271.html#8f4f02f530eb3f2e7ea26e06f76aef9d">empty</a> () const </td></tr>
  60. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">True if range is empty. <br></td></tr>
  61. <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00271.html#41a58b703d574b6e1ca155df3576f578">is_divisible</a> () const </td></tr>
  62. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">True if range is divisible. <a href="#41a58b703d574b6e1ca155df3576f578"></a><br></td></tr>
  63. <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00271.html#4c0efd2be3f96a0ab3ba5085e8b3fcc7">blocked_range</a> (<a class="el" href="a00271.html">blocked_range</a> &amp;r, <a class="el" href="a00347.html">split</a>)</td></tr>
  64. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Split range. <a href="#4c0efd2be3f96a0ab3ba5085e8b3fcc7"></a><br></td></tr>
  65. <tr><td colspan="2"><br><h2>Friends</h2></td></tr>
  66. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="395a514a55017e36d571809f1223389b"></a><!-- doxytag: member="tbb::blocked_range::blocked_range2d" ref="395a514a55017e36d571809f1223389b" args="" -->
  67. class&nbsp;</td><td class="memItemRight" valign="bottom"><b>blocked_range2d</b></td></tr>
  68. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="13d172a4da9be197033e64516fff1f4b"></a><!-- doxytag: member="tbb::blocked_range::blocked_range3d" ref="13d172a4da9be197033e64516fff1f4b" args="" -->
  69. class&nbsp;</td><td class="memItemRight" valign="bottom"><b>blocked_range3d</b></td></tr>
  70. </table>
  71. <hr><a name="_details"></a><h2>Detailed Description</h2>
  72. <h3>template&lt;typename Value&gt;<br>
  73. class tbb::blocked_range&lt; Value &gt;</h3>
  74. A range over which to iterate.
  75. <p>
  76. <hr><h2>Member Typedef Documentation</h2>
  77. <a class="anchor" name="1a8d05842c2b3dfc177bc4d347e4cef7"></a><!-- doxytag: member="tbb::blocked_range::const_iterator" ref="1a8d05842c2b3dfc177bc4d347e4cef7" args="" -->
  78. <div class="memitem">
  79. <div class="memproto">
  80. <div class="memtemplate">
  81. template&lt;typename Value&gt; </div>
  82. <table class="memname">
  83. <tr>
  84. <td class="memname">typedef Value <a class="el" href="a00271.html">tbb::blocked_range</a>&lt; Value &gt;::<a class="el" href="a00271.html#1a8d05842c2b3dfc177bc4d347e4cef7">const_iterator</a> </td>
  85. </tr>
  86. </table>
  87. </div>
  88. <div class="memdoc">
  89. <p>
  90. Type of a value.
  91. <p>
  92. Called a const_iterator for sake of algorithms that need to treat a <a class="el" href="a00271.html">blocked_range</a> as an STL container.
  93. </div>
  94. </div><p>
  95. <hr><h2>Constructor &amp; Destructor Documentation</h2>
  96. <a class="anchor" name="94607755c5110d199202234d58d022ac"></a><!-- doxytag: member="tbb::blocked_range::blocked_range" ref="94607755c5110d199202234d58d022ac" args="()" -->
  97. <div class="memitem">
  98. <div class="memproto">
  99. <div class="memtemplate">
  100. template&lt;typename Value&gt; </div>
  101. <table class="memname">
  102. <tr>
  103. <td class="memname"><a class="el" href="a00271.html">tbb::blocked_range</a>&lt; Value &gt;::<a class="el" href="a00271.html">blocked_range</a> </td>
  104. <td>(</td>
  105. <td class="paramname"> </td>
  106. <td>&nbsp;)&nbsp;</td>
  107. <td width="100%"><code> [inline]</code></td>
  108. </tr>
  109. </table>
  110. </div>
  111. <div class="memdoc">
  112. <p>
  113. Construct range with default-constructed values for begin and end.
  114. <p>
  115. Requires that Value have a default constructor.
  116. </div>
  117. </div><p>
  118. <a class="anchor" name="4c0efd2be3f96a0ab3ba5085e8b3fcc7"></a><!-- doxytag: member="tbb::blocked_range::blocked_range" ref="4c0efd2be3f96a0ab3ba5085e8b3fcc7" args="(blocked_range &amp;r, split)" -->
  119. <div class="memitem">
  120. <div class="memproto">
  121. <div class="memtemplate">
  122. template&lt;typename Value&gt; </div>
  123. <table class="memname">
  124. <tr>
  125. <td class="memname"><a class="el" href="a00271.html">tbb::blocked_range</a>&lt; Value &gt;::<a class="el" href="a00271.html">blocked_range</a> </td>
  126. <td>(</td>
  127. <td class="paramtype"><a class="el" href="a00271.html">blocked_range</a>&lt; Value &gt; &amp;&nbsp;</td>
  128. <td class="paramname"> <em>r</em>, </td>
  129. </tr>
  130. <tr>
  131. <td class="paramkey"></td>
  132. <td></td>
  133. <td class="paramtype"><a class="el" href="a00347.html">split</a>&nbsp;</td>
  134. <td class="paramname"></td><td>&nbsp;</td>
  135. </tr>
  136. <tr>
  137. <td></td>
  138. <td>)</td>
  139. <td></td><td></td><td width="100%"><code> [inline]</code></td>
  140. </tr>
  141. </table>
  142. </div>
  143. <div class="memdoc">
  144. <p>
  145. Split range.
  146. <p>
  147. The new Range *this has the second half, the old range r has the first half. Unspecified if <a class="el" href="a00271.html#8b929d93ddc13f148b11bceef3a3bdf8">end()</a>&lt;<a class="el" href="a00271.html#18d2258400756ac1446dac7676b18df3">begin()</a> or !is_divisible().
  148. </div>
  149. </div><p>
  150. <hr><h2>Member Function Documentation</h2>
  151. <a class="anchor" name="41a58b703d574b6e1ca155df3576f578"></a><!-- doxytag: member="tbb::blocked_range::is_divisible" ref="41a58b703d574b6e1ca155df3576f578" args="() const " -->
  152. <div class="memitem">
  153. <div class="memproto">
  154. <div class="memtemplate">
  155. template&lt;typename Value&gt; </div>
  156. <table class="memname">
  157. <tr>
  158. <td class="memname">bool <a class="el" href="a00271.html">tbb::blocked_range</a>&lt; Value &gt;::is_divisible </td>
  159. <td>(</td>
  160. <td class="paramname"> </td>
  161. <td>&nbsp;)&nbsp;</td>
  162. <td width="100%"> const<code> [inline]</code></td>
  163. </tr>
  164. </table>
  165. </div>
  166. <div class="memdoc">
  167. <p>
  168. True if range is divisible.
  169. <p>
  170. Unspecified if <a class="el" href="a00271.html#8b929d93ddc13f148b11bceef3a3bdf8">end()</a>&lt;<a class="el" href="a00271.html#18d2258400756ac1446dac7676b18df3">begin()</a>.
  171. </div>
  172. </div><p>
  173. <a class="anchor" name="9eaa0b6beff1420f688570bbf6b8c462"></a><!-- doxytag: member="tbb::blocked_range::size" ref="9eaa0b6beff1420f688570bbf6b8c462" args="() const " -->
  174. <div class="memitem">
  175. <div class="memproto">
  176. <div class="memtemplate">
  177. template&lt;typename Value&gt; </div>
  178. <table class="memname">
  179. <tr>
  180. <td class="memname"><a class="el" href="a00271.html#f5707bffea38eee5c9680f37358afb8e">size_type</a> <a class="el" href="a00271.html">tbb::blocked_range</a>&lt; Value &gt;::size </td>
  181. <td>(</td>
  182. <td class="paramname"> </td>
  183. <td>&nbsp;)&nbsp;</td>
  184. <td width="100%"> const<code> [inline]</code></td>
  185. </tr>
  186. </table>
  187. </div>
  188. <div class="memdoc">
  189. <p>
  190. Size of the range.
  191. <p>
  192. Unspecified if <a class="el" href="a00271.html#8b929d93ddc13f148b11bceef3a3bdf8">end()</a>&lt;<a class="el" href="a00271.html#18d2258400756ac1446dac7676b18df3">begin()</a>.
  193. </div>
  194. </div><p>
  195. <hr>The documentation for this class was generated from the following file:<ul>
  196. <li>blocked_range.h</ul>
  197. <hr>
  198. <p></p>
  199. Copyright &copy; 2005-2013 Intel Corporation. All Rights Reserved.
  200. <p></p>
  201. Intel, Pentium, Intel Xeon, Itanium, Intel XScale and VTune are
  202. registered trademarks or trademarks of Intel Corporation or its
  203. subsidiaries in the United States and other countries.
  204. <p></p>
  205. * Other names and brands may be claimed as the property of others.