ceph/src/boost/libs/mpl/doc/refmanual/prior.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.7: http://docutils.sourceforge.net/" />
   7 <title>The MPL Reference Manual: prior</title>
   8 <link rel="stylesheet" href="../style.css" type="text/css" />
   9 </head>
  10 <body class="docframe refmanual">
  11 <table class="header"><tr class="header"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./next.html" class="navigation-link">Prev</a>&nbsp;<a href="./deref.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./next.html" class="navigation-link">Back</a>&nbsp;<a href="./deref.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./iterator-metafunctions.html" class="navigation-link">Up</a>&nbsp;<a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./refmanual_toc.html" class="navigation-link">Full TOC</a></span></td>
  12 <td class="header-group page-location"><a href="../refmanual.html" class="navigation-link">Front Page</a> / <a href="./iterators.html" class="navigation-link">Iterators</a> / <a href="./iterator-metafunctions.html" class="navigation-link">Iterator Metafunctions</a> / <a href="./prior.html" class="navigation-link">prior</a></td>
  13 </tr></table><div class="header-separator"></div>
  14 <div class="section" id="prior">
  15 <h1><a class="toc-backref" href="./iterator-metafunctions.html#id1457">prior</a></h1>
  16 <div class="section" id="id429">
  17 <h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3>
  18 <pre class="literal-block">
  19 template&lt;
  20       typename Iterator
  21     &gt;
  22 struct <a href="./prior.html" class="identifier">prior</a>
  23 {
  24     typedef <em>unspecified</em> type;
  25 };
  26 </pre>
  27 </div>
  28 <div class="section" id="id430">
  29 <h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
  30 <p>Returns the previous iterator in the sequence. [<em>Note:</em> <tt class="literal"><span class="pre"><a href="./prior.html" class="identifier">prior</a></span></tt> has a number of
  31 overloaded meanings, depending on the type of its argument. For instance,
  32 if <tt class="literal"><span class="pre">X</span></tt> is an <a class="reference internal" href="./integral-constant.html">Integral Constant</a>, <tt class="literal"><span class="pre"><a href="./prior.html" class="identifier">prior</a>&lt;X&gt;</span></tt> returns an decremented
  33 <a class="reference internal" href="./integral-constant.html">Integral Constant</a> of the same type. The following specification is
  34 iterator-specific. Please refer to the corresponding concept's
  35 documentation for the details of the alternative semantics — <em>end note</em>].</p>
  36 </div>
  37 <div class="section" id="id431">
  38 <h3><a class="subsection-title" href="#header" name="header">Header</a></h3>
  39 <pre class="literal-block">
  40 #include &lt;<a href="../../../../boost/mpl/next_prior.hpp" class="header">boost/mpl/next_prior.hpp</a>&gt;
  41 </pre>
  42 </div>
  43 <div class="section" id="id432">
  44 <h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3>
  45 <table border="1" class="docutils table">
  46 <colgroup>
  47 <col width="19%" />
  48 <col width="35%" />
  49 <col width="45%" />
  50 </colgroup>
  51 <thead valign="bottom">
  52 <tr><th class="head">Parameter</th>
  53 <th class="head">Requirement</th>
  54 <th class="head">Description</th>
  55 </tr>
  56 </thead>
  57 <tbody valign="top">
  58 <tr><td><tt class="literal"><span class="pre">Iterator</span></tt></td>
  59 <td><a class="reference internal" href="./bidirectional-iterator.html">Bidirectional Iterator</a>.</td>
  60 <td>An iterator to decrement.</td>
  61 </tr>
  62 </tbody>
  63 </table>
  64 </div>
  65 <div class="section" id="id433">
  66 <h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
  67 <p>For any <a class="reference internal" href="./bidirectional-iterator.html">Bidirectional Iterator</a>s <tt class="literal"><span class="pre">iter</span></tt>:</p>
  68 <pre class="literal-block">
  69 typedef <a href="./prior.html" class="identifier">prior</a>&lt;iter&gt;::type j;
  70 </pre>
  71 <table class="docutils field-list" frame="void" rules="none">
  72 <col class="field-name" />
  73 <col class="field-body" />
  74 <tbody valign="top">
  75 <tr class="field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="./bidirectional-iterator.html">Bidirectional Iterator</a>.</p>
  76 </td>
  77 </tr>
  78 <tr class="field"><th class="field-name">Precondition:</th><td class="field-body"><p class="first"><tt class="literal"><span class="pre">iter</span></tt> is decrementable.</p>
  79 </td>
  80 </tr>
  81 <tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><p class="first"><tt class="literal"><span class="pre">j</span></tt> is an iterator pointing to the previous element in the sequence.
  82 If <tt class="literal"><span class="pre">iter</span></tt> is a user-defined iterator, the library-provided default
  83 implementation is equivalent to</p>
  84 <pre class="last literal-block">
  85 typedef iter::<a href="./prior.html" class="identifier">prior</a> j;
  86 </pre>
  87 </td>
  88 </tr>
  89 </tbody>
  90 </table>
  91 </div>
  92 <div class="section" id="id434">
  93 <h3><a class="subsection-title" href="#complexity" name="complexity">Complexity</a></h3>
  94 <p>Amortized constant time.</p>
  95 </div>
  96 <div class="section" id="id435">
  97 <h3><a class="subsection-title" href="#example" name="example">Example</a></h3>
  98 <pre class="literal-block">
  99 typedef <a href="./vector-c.html" class="identifier">vector_c</a>&lt;int,1&gt; v;
 100 typedef <a href="./begin.html" class="identifier">begin</a>&lt;v&gt;::type first;
 101 typedef <a href="./end.html" class="identifier">end</a>&lt;v&gt;::type last;
 102
 103 <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same&lt; <a href="./prior.html" class="identifier">prior</a>&lt;last&gt;::type, first > ));
 104 </pre>
 105 </div>
 106 <div class="section" id="id436">
 107 <h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
 108 <p><a class="reference internal" href="./iterators.html">Iterators</a>, <a class="reference internal" href="./begin.html">begin</a> / <a class="reference internal" href="./end.html">end</a>, <a class="reference internal" href="./next.html">next</a>, <a class="reference internal" href="./deref.html">deref</a></p>
 109 <!-- Iterators/Iterator Metafunctions//deref |50 -->
 110 </div>
 111 </div>
 112
 113 <div class="footer-separator"></div>
 114 <table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./next.html" class="navigation-link">Prev</a>&nbsp;<a href="./deref.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./next.html" class="navigation-link">Back</a>&nbsp;<a href="./deref.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./iterator-metafunctions.html" class="navigation-link">Up</a>&nbsp;<a href="../refmanual.html" class="navigation-link">Home</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./refmanual_toc.html" class="navigation-link">Full TOC</a></span></td>
 115 <td><div class="copyright-footer"><div class="copyright">Copyright ©  2001-2009 Aleksey Gurtovoy and David Abrahams</div>
 116 Distributed under the Boost Software License, Version 1.0. (See accompanying
 117 file LICENSE_1_0.txt or copy at <a class="reference external" href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)</div></td></tr></table></body>
 118 </html>