ceph/src/boost/libs/iterator/doc/SwappableIterator.html

   1 <?xml version="1.0" encoding="utf-8" ?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   6 <meta name="generator" content="Docutils 0.5: http://docutils.sourceforge.net/" />
   7 <title>Swappable Iterator Concept</title>
   8 <link rel="stylesheet" href="../../../rst.css" type="text/css" />
   9 </head>
  10 <body>
  11 <div class="document" id="swappable-iterator-concept">
  12 <h1 class="title">Swappable Iterator Concept</h1>
  13
  14 <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
  15 <!-- Software License, Version 1.0. (See accompanying -->
  16 <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
  17 <p>A class or built-in type <tt class="docutils literal"><span class="pre">X</span></tt> models the <em>Swappable Iterator</em> concept
  18 if, in addition to <tt class="docutils literal"><span class="pre">X</span></tt> being Copy Constructible, the following
  19 expressions are valid and respect the stated semantics.</p>
  20 <table border="1" class="docutils">
  21 <colgroup>
  22 <col width="37%" />
  23 <col width="19%" />
  24 <col width="43%" />
  25 </colgroup>
  26 <thead valign="bottom">
  27 <tr><th class="head" colspan="3">Swappable Iterator Requirements (in addition to Copy Constructible)</th>
  28 </tr>
  29 <tr><th class="head">Expression</th>
  30 <th class="head">Return Type</th>
  31 <th class="head">Postcondition</th>
  32 </tr>
  33 </thead>
  34 <tbody valign="top">
  35 <tr><td><tt class="docutils literal"><span class="pre">iter_swap(a,</span> <span class="pre">b)</span></tt></td>
  36 <td><tt class="docutils literal"><span class="pre">void</span></tt></td>
  37 <td>the pointed to values are
  38 exchanged</td>
  39 </tr>
  40 </tbody>
  41 </table>
  42 <dl class="docutils">
  43 <dt>[<em>Note:</em> An iterator that is a model of the <em>Readable</em> and <em>Writable Iterator</em> concepts</dt>
  44 <dd>is also a model of <em>Swappable Iterator</em>.  <em>--end note</em>]</dd>
  45 </dl>
  46 </div>
  47 <div class="footer">
  48 <hr class="footer" />
  49 <a class="reference external" href="SwappableIterator.rst">View document source</a>.
  50 Generated by <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
  51
  52 </div>
  53 </body>
  54 </html>