Home Explore Help
Register Sign In
devn00b
/
EQ2EMu
9
3
Fork 0
Files Issues 59
Tree: c82684228b
Branches Tags
EQ2EMu
/
EQ2
/
source
/
depends
/
boost_1_72_0
/
libs
/
concept_check
/
doc
/
html
/
OutputIterator.html

OutputIterator.html 11 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222 
  1. <html>
    2. 

  2. <head>
    3. 

  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
    4. 

  4. <title>Concept OutputIterator</title>
    5. 

  5. <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
    6. 

  6. <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
    7. 

  7. <link rel="home" href="index.html" title="Concept reference">
    8. 

  8. <link rel="up" href="index.html" title="Concept reference">
    9. 

  9. <link rel="prev" href="InputIterator.html" title="Concept InputIterator">
    10. 

  10. <link rel="next" href="ForwardIterator.html" title="Concept ForwardIterator">
    11. 

  11. </head>
    12. 

  12. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
    13. 

  13. <table cellpadding="2" width="100%"><tr>
    14. 

  14. <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
    15. 

  15. <td align="center"><a href="../../../../index.html">Home</a></td>
    16. 

  16. <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
    17. 

  17. <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
    18. 

  18. <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
    19. 

  19. <td align="center"><a href="../../../../more/index.htm">More</a></td>
    20. 

  20. </tr></table>
    21. 

  21. <hr>
    22. 

  22. <div class="spirit-nav">
    23. 

  23. <a accesskey="p" href="InputIterator.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="index.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="ForwardIterator.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
    24. 

  24. </div>
    25. 

  25. <div class="refentry">
    26. 

  26. <a name="OutputIterator"></a><div class="titlepage"></div>
    27. 

  27. <div class="refnamediv">
    28. 

  28. <h2><span class="refentrytitle">Concept OutputIterator</span></h2>
    29. 

  29. <p>OutputIterator</p>
    30. 

  30. </div>
    31. 

  31. <div class="refsect1">
    32. 

  32. <a name="idm45853365511104"></a><h2>Description</h2>
    33. 

  33. <p>An output iterator is an iterator that can write a sequence of
    34. 

  34.   values.  It is single-pass (old values of the iterator cannot be
    35. 

  35.   re-used), and write-only.</p>
    36. 

  36. <p>An output iterator represents a position in a (possibly infinite)
    37. 

  37.   sequence.  Therefore, the iterator can point into the sequence (returning
    38. 

  38.   a value when dereferenced and being incrementable), or be off-the-end
    39. 

  39.   (and not dereferenceable or incrementable).</p>
    40. 

  40. </div>
    41. 

  41. <div class="refsect1">
    42. 

  42. <a name="idm45853365509376"></a><h2>Associated types</h2>
    43. 

  43. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
    44. 

  44. <li class="listitem">
    45. 

  45. <p><span class="bold"><strong>value_type</strong></span></p>
    46. 

  46. <pre class="literallayout">std::iterator_traits&lt;Iter&gt;::value_type</pre>
    47. 

  47. <p>The stated value type of the iterator (should be
    48. 

  48.     <code class="computeroutput">void</code> for an output iterator that does not model some other
    49. 

  49.     iterator concept).</p>
    50. 

  50. </li>
    51. 

  51. <li class="listitem">
    52. 

  52. <p><span class="bold"><strong>difference_type</strong></span></p>
    53. 

  53. <pre class="literallayout">std::iterator_traits&lt;Iter&gt;::difference_type</pre>
    54. 

  54. <p>The difference type of the iterator</p>
    55. 

  55. </li>
    56. 

  56. <li class="listitem">
    57. 

  57. <p><span class="bold"><strong>category</strong></span></p>
    58. 

  58. <pre class="literallayout">std::iterator_traits&lt;Iter&gt;::iterator_category</pre>
    59. 

  59. <p>The category of the iterator</p>
    60. 

  60. </li>
    61. 

  61. </ul></div>
    62. 

  62. </div>
    63. 

  63. <div class="refsect1">
    64. 

  64. <a name="idm45853365502864"></a><h2>Notation</h2>
    65. 

  65. <div class="variablelist"><dl class="variablelist">
    66. 

  66. <dt><span class="term">Iter</span></dt>
    67. 

  67. <dd>A type playing the role of iterator-type in the <a class="link" href="OutputIterator.html" title="Concept OutputIterator">OutputIterator</a> concept.</dd>
    68. 

  68. <dt><span class="term">ValueType</span></dt>
    69. 

  69. <dd>A type playing the role of value-type in the <a class="link" href="OutputIterator.html" title="Concept OutputIterator">OutputIterator</a> concept.</dd>
    70. 

  70. <dt>
    71. 

  71. <span class="term"><code class="varname">i</code>, </span><span class="term"><code class="varname">j</code></span>
    72. 

  72. </dt>
    73. 

  73. <dd>Objects of type Iter</dd>
    74. 

  74. <dt><span class="term"><code class="varname">x</code></span></dt>
    75. 

  75. <dd>Object of type ValueType</dd>
    76. 

  76. </dl></div>
    77. 

  77. </div>
    78. 

  78. <div class="refsect1">
    79. 

  79. <a name="idm45853365497392"></a><h2>Type expressions</h2>
    80. 

  80. <div class="variablelist"><dl class="variablelist">
    81. 

  81. <dt><span class="term"></span></dt>
    82. 

  82. <dd><p>The type <span class="type">Iter</span> must be a model of <a class="link" href="Assignable.html" title="Concept Assignable">Assignable</a>.</p></dd>
    83. 

  83. <dt><span class="term"></span></dt>
    84. 

  84. <dd><p>The type <span class="type">ValueType</span> must be a model of <a class="link" href="Assignable.html" title="Concept Assignable">Assignable</a>.</p></dd>
    85. 

  85. <dt><span class="term"></span></dt>
    86. 

  86. <dd><p>The type <span class="type">Iter</span> must be a model of <a class="link" href="DefaultConstructible.html" title="Concept DefaultConstructible">DefaultConstructible</a>.</p></dd>
    87. 

  87. <dt><span class="term"></span></dt>
    88. 

  88. <dd><p>The type <span class="type">Iter</span> must be a model of
    89. 

  89.   <a class="link" href="EqualityComparable.html" title="Concept EqualityComparable">EqualityComparable</a>.</p></dd>
    90. 

  90. <dt><span class="term">Category tag</span></dt>
    91. 

  91. <dd><p><span class="type">category</span> must be
    92. 

  92.                   derived from <span class="type">std::output_iterator_tag</span>,  a model  of <a class="link" href="DefaultConstructible.html" title="Concept DefaultConstructible">DefaultConstructible</a>,  and  a model  of <a class="link" href="CopyConstructible.html" title="Concept CopyConstructible">CopyConstructible</a>.
    93. 

  93.                 </p></dd>
    94. 

  94. <dt><span class="term">Difference type properties</span></dt>
    95. 

  95. <dd><p><span class="type">difference_type</span> must be
    96. 

  96.                    a model  of <a class="link" href="SignedInteger.html" title="Concept SignedInteger">SignedInteger</a>.
    97. 

  97.                 </p></dd>
    98. 

  98. </dl></div>
    99. 

  99. </div>
    100. 

  100. <div class="refsect1">
    101. 

  101. <a name="idm45853365485984"></a><h2>Valid expressions</h2>
    102. 

  102. <div class="informaltable"><table class="table">
    103. 

  103. <colgroup>
    104. 

  104. <col>
    105. 

  105. <col>
    106. 

  106. <col>
    107. 

  107. <col>
    108. 

  108. <col>
    109. 

  109. <col>
    110. 

  110. </colgroup>
    111. 

  111. <thead><tr>
    112. 

  112. <th>Name</th>
    113. 

  113. <th>Expression</th>
    114. 

  114. <th>Type</th>
    115. 

  115. <th>Precondition</th>
    116. 

  116. <th>Semantics</th>
    117. 

  117. <th>Postcondition</th>
    118. 

  118. </tr></thead>
    119. 

  119. <tbody>
    120. 

  120. <tr>
    121. 

  121. <td><p>Dereference</p></td>
    122. 

  122. <td><p>*i</p></td>
    123. 

  123. <td><p></p></td>
    124. 

  124. <td><p><code class="computeroutput">i</code> is incrementable (not
    125. 

  125.     off-the-end)</p></td>
    126. 

  126. <td>&#160;</td>
    127. 

  127. <td>&#160;</td>
    128. 

  128. </tr>
    129. 

  129. <tr>
    130. 

  130. <td><p>Dereference and assign</p></td>
    131. 

  131. <td><p>*i = x</p></td>
    132. 

  132. <td><p></p></td>
    133. 

  133. <td><p><code class="computeroutput">i</code> is incrementable (not
    134. 

  134.     off-the-end)</p></td>
    135. 

  135. <td>&#160;</td>
    136. 

  136. <td><p><code class="computeroutput">*i</code> may not be written to again until it has
    137. 

  137.     been incremented.</p></td>
    138. 

  138. </tr>
    139. 

  139. <tr>
    140. 

  140. <td><p>Preincrement</p></td>
    141. 

  141. <td><p>++i</p></td>
    142. 

  142. <td><p><span class="type">Iter &amp;</span></p></td>
    143. 

  143. <td><p><code class="computeroutput">i</code> is incrementable (not
    144. 

  144.     off-the-end)</p></td>
    145. 

  145. <td>&#160;</td>
    146. 

  146. <td>&#160;</td>
    147. 

  147. </tr>
    148. 

  148. <tr>
    149. 

  149. <td><p>Postincrement</p></td>
    150. 

  150. <td><p>i++</p></td>
    151. 

  151. <td><p></p></td>
    152. 

  152. <td><p><code class="computeroutput">i</code> is incrementable (not
    153. 

  153.     off-the-end)</p></td>
    154. 

  154. <td><p>Equivalent to <code class="computeroutput">(void)(++i)</code></p></td>
    155. 

  155. <td><p><code class="computeroutput">i</code> is dereferenceable or
    156. 

  156.     off-the-end</p></td>
    157. 

  157. </tr>
    158. 

  158. <tr>
    159. 

  159. <td><p>Postincrement, dereference, and assign</p></td>
    160. 

  160. <td><p>*i++ = x</p></td>
    161. 

  161. <td><p></p></td>
    162. 

  162. <td><p><code class="computeroutput">i</code> is incrementable (not
    163. 

  163.     off-the-end)</p></td>
    164. 

  164. <td><p>Equivalent to <code class="computeroutput">{*i = t; ++i;}</code></p></td>
    165. 

  165. <td><p><code class="computeroutput">i</code> is dereferenceable or
    166. 

  166.     off-the-end</p></td>
    167. 

  167. </tr>
    168. 

  168. </tbody>
    169. 

  169. </table></div>
    170. 

  170. </div>
    171. 

  171. <div class="refsect1">
    172. 

  172. <a name="idm45853365467728"></a><h2>Complexity</h2>
    173. 

  173. <p>
    174. 

  174.   All iterator operations must take amortized constant time.
    175. 

  175.   </p>
    176. 

  176. </div>
    177. 

  177. <div class="refsect1">
    178. 

  178. <a name="idm45853365467088"></a><h2>Models</h2>
    179. 

  179. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
    180. 

  180. <li class="listitem"><span class="simplelist"><span class="type">std::ostream_iterator</span>, <span class="type">...</span></span></li>
    181. 

  181. <li class="listitem"><span class="simplelist"><span class="type">std::insert_iterator</span>, <span class="type">...</span></span></li>
    182. 

  182. <li class="listitem"><span class="simplelist"><span class="type">std::front_insert_iterator</span>, <span class="type">...</span></span></li>
    183. 

  183. <li class="listitem"><span class="simplelist"><span class="type">std::back_insert_iterator</span>, <span class="type">...</span></span></li>
    184. 

  184. </ul></div>
    185. 

  185. </div>
    186. 

  186. </div>
    187. 

  187. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
    188. 

  188. <td align="left"></td>
    189. 

  189. <td align="right"><div class="copyright-footer">Copyright &#169; 2001, 2002 Indiana University<br>Copyright &#169; 2000, 2001 University of Notre Dame du Lac<br>Copyright &#169; 2000 Jeremy Siek, Lie-Quan Lee, Andrew Lumsdaine<br>Copyright &#169; 1996-1999 Silicon Graphics Computer Systems, Inc.<br>Copyright &#169; 1994 Hewlett-Packard Company<p>Distributed under the Boost Software License, Version 1.0.
    190. 

  190.       (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at 
    191. 

  191.       <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
    192. 

  192.       </p>
    193. 

  193. <p>This product includes software developed at the University
    194. 

  194.       of Notre Dame and the Pervasive Technology Labs at Indiana
    195. 

  195.       University. For technical information contact Andrew Lumsdaine
    196. 

  196.       at the Pervasive Technology Labs at Indiana University.  For
    197. 

  197.       administrative and license questions contact the Advanced
    198. 

  198.       Research and Technology Institute at 351 West 10th Street.
    199. 

  199.       Indianapolis, Indiana 46202, phone 317-278-4100, fax
    200. 

  200.       317-274-5902.</p>
    201. 

  201. <p>Some concepts based on versions from the MTL draft manual
    202. 

  202.       and Boost Graph and Property Map documentation, the SGI Standard
    203. 

  203.       Template Library documentation and the Hewlett-Packard STL,
    204. 

  204.       under the following license: 
    205. 

  205.         </p>
    206. 

  206. <div class="blockquote"><blockquote class="blockquote"><p>Permission to use, copy, modify, distribute and
    207. 

  207.         sell this software and its documentation for any purpose is
    208. 

  208.         hereby granted without fee, provided that the above copyright
    209. 

  209.         notice appears in all copies and that both that copyright
    210. 

  210.         notice and this permission notice appear in supporting
    211. 

  211.         documentation.  Silicon Graphics makes no representations
    212. 

  212.         about the suitability of this software for any purpose.  It is
    213. 

  213.         provided "as is" without express or implied
    214. 

  214.         warranty.</p></blockquote></div>
    215. 

  215. </div></td>
    216. 

  216. </tr></table>
    217. 

  217. <hr>
    218. 

  218. <div class="spirit-nav">
    219. 

  219. <a accesskey="p" href="InputIterator.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="index.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="ForwardIterator.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
    220. 

  220. </div>
    221. 

  221. </body>
    222. 

  222. </html>
    223.