ceph/src/boost/libs/mpl/doc/refmanual/set.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: set</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="./deque.html" class="navigation-link">Prev</a>&nbsp;<a href="./map.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./deque.html" class="navigation-link">Back</a>&nbsp;<a href="./map.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./classes.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="./sequences.html" class="navigation-link">Sequences</a> / <a href="./classes.html" class="navigation-link">Classes</a> / <a href="./set.html" class="navigation-link">set</a></td>
  13 </tr></table><div class="header-separator"></div>
  14 <div class="section" id="set">
  15 <h1><a class="toc-backref" href="./classes.html#id1410">set</a></h1>
  16 <div class="section" id="id72">
  17 <h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
  18 <p><tt class="literal"><span class="pre"><a href="./set.html" class="identifier">set</a></span></tt> is a <a class="reference internal" href="./variadic-sequence.html">variadic</a>, <a class="reference internal" href="./associative-sequence.html">associative</a>, <a class="reference internal" href="./extensible-associative-sequence.html">extensible</a> sequence of types that
  19 supports constant-time insertion and removal of elements, and testing for membership.
  20 A <tt class="literal"><span class="pre"><a href="./set.html" class="identifier">set</a></span></tt> may contain at most one element for each key.</p>
  21 </div>
  22 <div class="section" id="id75">
  23 <h3><a class="subsection-title" href="#header" name="header">Header</a></h3>
  24 <table border="1" class="docutils table">
  25 <colgroup>
  26 <col width="26%" />
  27 <col width="74%" />
  28 </colgroup>
  29 <thead valign="bottom">
  30 <tr><th class="head">Sequence form</th>
  31 <th class="head">Header</th>
  32 </tr>
  33 </thead>
  34 <tbody valign="top">
  35 <tr><td>Variadic</td>
  36 <td><tt class="literal"><span class="pre">#include &lt;<a href="../../../../boost/mpl/set.hpp" class="header">boost/mpl/set.hpp</a>&gt;</span></tt></td>
  37 </tr>
  38 <tr><td>Numbered</td>
  39 <td><tt class="literal"><span class="pre">#include &lt;boost/mpl/set/set</span></tt><em>n</em><tt class="literal"><span class="pre">.hpp&gt;</span></tt></td>
  40 </tr>
  41 </tbody>
  42 </table>
  43 </div>
  44 <div class="section" id="id76">
  45 <h3><a class="subsection-title" href="#model-of" name="model-of">Model of</a></h3>
  46 <ul class="simple">
  47 <li><a class="reference internal" href="./variadic-sequence.html">Variadic Sequence</a></li>
  48 <li><a class="reference internal" href="./associative-sequence.html">Associative Sequence</a></li>
  49 <li><a class="reference internal" href="./extensible-associative-sequence.html">Extensible Associative Sequence</a></li>
  50 </ul>
  51 </div>
  52 <div class="section" id="id77">
  53 <h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
  54 <p>In the following table, <tt class="literal"><span class="pre">s</span></tt> is an instance of <tt class="literal"><span class="pre"><a href="./set.html" class="identifier">set</a></span></tt>, <tt class="literal"><span class="pre">pos</span></tt> is an iterator into <tt class="literal"><span class="pre">s</span></tt>,
  55 and <tt class="literal"><span class="pre">x</span></tt>, <tt class="literal"><span class="pre">k</span></tt>, and <em>t</em><sub>1</sub>,<em>t</em><sub>2</sub>,... <em>t</em><sub>n</sub> is a set of <em>unique</em> arbitrary types. [<em>Note:</em> See <a class="reference internal" href="./set.html#nonunique-set-example">below</a> for
  56 an example of how to construct a <tt class="literal"><span class="pre"><a href="./set.html" class="identifier">set</a></span></tt> from a list of potentially non-unique types — <em>end note</em>]</p>
  57 <table border="1" class="docutils table">
  58 <colgroup>
  59 <col width="40%" />
  60 <col width="60%" />
  61 </colgroup>
  62 <thead valign="bottom">
  63 <tr><th class="head">Expression</th>
  64 <th class="head">Semantics</th>
  65 </tr>
  66 </thead>
  67 <tbody valign="top">
  68 <tr><td><pre class="first last literal-block">
  69 <a href="./set.html" class="identifier">set</a>&lt;<em>t</em><sub>1</sub>,<em>t</em><sub>2</sub>,... <em>t</em><sub>n</sub>&gt;
  70 <a href="./set.html" class="identifier">set</a><em>n</em>&lt;<em>t</em><sub>1</sub>,<em>t</em><sub>2</sub>,... <em>t</em><sub>n</sub>&gt;
  71 </pre>
  72 </td>
  73 <td><tt class="literal"><span class="pre"><a href="./set.html" class="identifier">set</a></span></tt> of elements <em>t</em><sub>1</sub>,<em>t</em><sub>2</sub>,... <em>t</em><sub>n</sub>; see
  74 <a class="reference internal" href="./variadic-sequence.html">Variadic Sequence</a>.</td>
  75 </tr>
  76 <tr><td><pre class="first last literal-block">
  77 <a href="./set.html" class="identifier">set</a>&lt;<em>t</em><sub>1</sub>,<em>t</em><sub>2</sub>,... <em>t</em><sub>n</sub>&gt;::type
  78 <a href="./set.html" class="identifier">set</a><em>n</em>&lt;<em>t</em><sub>1</sub>,<em>t</em><sub>2</sub>,... <em>t</em><sub>n</sub>&gt;::type
  79 </pre>
  80 </td>
  81 <td>Identical to <tt class="literal"><span class="pre"><a href="./set.html" class="identifier">set</a></span></tt><em>n</em><tt class="literal"><span class="pre">&lt;</span></tt><em>t</em><sub>1</sub>,<em>t</em><sub>2</sub>,... <em>t</em><sub>n</sub><tt class="literal"><span class="pre">&gt;</span></tt>;
  82 see <a class="reference internal" href="./variadic-sequence.html">Variadic Sequence</a>.</td>
  83 </tr>
  84 <tr><td><tt class="literal"><span class="pre"><a href="./begin.html" class="identifier">begin</a>&lt;s&gt;::type</span></tt></td>
  85 <td>An iterator pointing to the beginning of <tt class="literal"><span class="pre">s</span></tt>;
  86 see <a class="reference internal" href="./associative-sequence.html">Associative Sequence</a>.</td>
  87 </tr>
  88 <tr><td><tt class="literal"><span class="pre"><a href="./end.html" class="identifier">end</a>&lt;s&gt;::type</span></tt></td>
  89 <td>An iterator pointing to the end of <tt class="literal"><span class="pre">s</span></tt>;
  90 see <a class="reference internal" href="./associative-sequence.html">Associative Sequence</a>.</td>
  91 </tr>
  92 <tr><td><tt class="literal"><span class="pre"><a href="./size.html" class="identifier">size</a>&lt;s&gt;::type</span></tt></td>
  93 <td>The size of <tt class="literal"><span class="pre">s</span></tt>; see <a class="reference internal" href="./associative-sequence.html">Associative Sequence</a>.</td>
  94 </tr>
  95 <tr><td><tt class="literal"><span class="pre"><a href="./empty.html" class="identifier">empty</a>&lt;s&gt;::type</span></tt></td>
  96 <td>A boolean <a class="reference internal" href="./integral-constant.html">Integral Constant</a> <tt class="literal"><span class="pre">c</span></tt> such that
  97 <tt class="literal"><span class="pre">c::value</span> <span class="pre">==</span> <span class="pre">true</span></tt> if and only if <tt class="literal"><span class="pre">s</span></tt> is empty; see
  98 <a class="reference internal" href="./associative-sequence.html">Associative Sequence</a>.</td>
  99 </tr>
 100 <tr><td><tt class="literal"><span class="pre"><a href="./front.html" class="identifier">front</a>&lt;s&gt;::type</span></tt></td>
 101 <td>The first element in <tt class="literal"><span class="pre">s</span></tt>; see
 102 <a class="reference internal" href="./associative-sequence.html">Associative Sequence</a>.</td>
 103 </tr>
 104 <tr><td><tt class="literal"><span class="pre"><a href="./has-key.html" class="identifier">has_key</a>&lt;s,k&gt;::type</span></tt></td>
 105 <td>A boolean <a class="reference internal" href="./integral-constant.html">Integral Constant</a> <tt class="literal"><span class="pre">c</span></tt> such that
 106 <tt class="literal"><span class="pre">c::value</span> <span class="pre">==</span> <span class="pre">true</span></tt> if and only if there is one or more elements
 107 with the key <tt class="literal"><span class="pre">k</span></tt> in <tt class="literal"><span class="pre">s</span></tt>; see <a class="reference internal" href="./associative-sequence.html">Associative Sequence</a>.</td>
 108 </tr>
 109 <tr><td><tt class="literal"><span class="pre"><a href="./count.html" class="identifier">count</a>&lt;s,k&gt;::type</span></tt></td>
 110 <td>The number of elements with the key <tt class="literal"><span class="pre">k</span></tt> in <tt class="literal"><span class="pre">s</span></tt>;
 111 see <a class="reference internal" href="./associative-sequence.html">Associative Sequence</a>.</td>
 112 </tr>
 113 <tr><td><tt class="literal"><span class="pre"><a href="./order.html" class="identifier">order</a>&lt;s,k&gt;::type</span></tt></td>
 114 <td>A unique unsigned <a class="reference internal" href="./integral-constant.html">Integral Constant</a> associated with
 115 the key <tt class="literal"><span class="pre">k</span></tt> in <tt class="literal"><span class="pre">s</span></tt>; see <a class="reference internal" href="./associative-sequence.html">Associative Sequence</a>.</td>
 116 </tr>
 117 <tr><td><pre class="first last literal-block">
 118 <a href="./at.html" class="identifier">at</a>&lt;s,k&gt;::type
 119 <a href="./at.html" class="identifier">at</a>&lt;s,k,def&gt;::type
 120 </pre>
 121 </td>
 122 <td>The element associated with the key <tt class="literal"><span class="pre">k</span></tt> in
 123 <tt class="literal"><span class="pre">s</span></tt>; see <a class="reference internal" href="./associative-sequence.html">Associative Sequence</a>.</td>
 124 </tr>
 125 <tr><td><tt class="literal"><span class="pre"><a href="./key-type.html" class="identifier">key_type</a>&lt;s,x&gt;::type</span></tt></td>
 126 <td>Identical to <tt class="literal"><span class="pre">x</span></tt>; see <a class="reference internal" href="./associative-sequence.html">Associative Sequence</a>.</td>
 127 </tr>
 128 <tr><td><tt class="literal"><span class="pre"><a href="./value-type.html" class="identifier">value_type</a>&lt;s,x&gt;::type</span></tt></td>
 129 <td>Identical to <tt class="literal"><span class="pre">x</span></tt>; see <a class="reference internal" href="./associative-sequence.html">Associative Sequence</a>.</td>
 130 </tr>
 131 <tr><td><tt class="literal"><span class="pre"><a href="./insert.html" class="identifier">insert</a>&lt;s,x&gt;::type</span></tt></td>
 132 <td><p class="first">A new <tt class="literal"><span class="pre"><a href="./set.html" class="identifier">set</a></span></tt> equivalent to <tt class="literal"><span class="pre">s</span></tt> except that</p>
 133 <pre class="literal-block">
 134 <a href="./at.html" class="identifier">at</a>&lt; t, <a href="./key-type.html" class="identifier">key_type</a>&lt;s,x&gt;::type &gt;::type
 135 </pre>
 136 <p class="last">is identical to <tt class="literal"><span class="pre"><a href="./value-type.html" class="identifier">value_type</a>&lt;s,x&gt;::type</span></tt>.</p>
 137 </td>
 138 </tr>
 139 <tr><td><tt class="literal"><span class="pre"><a href="./insert.html" class="identifier">insert</a>&lt;s,pos,x&gt;::type</span></tt></td>
 140 <td>Equivalent to <tt class="literal"><span class="pre"><a href="./insert.html" class="identifier">insert</a>&lt;s,x&gt;::type</span></tt>; <tt class="literal"><span class="pre">pos</span></tt> is ignored.</td>
 141 </tr>
 142 <tr><td><tt class="literal"><span class="pre"><a href="./erase-key.html" class="identifier">erase_key</a>&lt;s,k&gt;::type</span></tt></td>
 143 <td>A new <tt class="literal"><span class="pre"><a href="./set.html" class="identifier">set</a></span></tt> equivalent to <tt class="literal"><span class="pre">s</span></tt> except that
 144 <tt class="literal"><span class="pre"><a href="./has-key.html" class="identifier">has_key</a>&lt;t,</span> <span class="pre">k&gt;::value</span> <span class="pre">==</span> <span class="pre">false</span></tt>.</td>
 145 </tr>
 146 <tr><td><tt class="literal"><span class="pre"><a href="./erase.html" class="identifier">erase</a>&lt;s,pos&gt;::type</span></tt></td>
 147 <td>Equivalent to <tt class="literal"><span class="pre"><a href="./erase.html" class="identifier">erase</a>&lt;s,</span> <span class="pre"><a href="./deref.html" class="identifier">deref</a>&lt;pos&gt;::type</span> <span class="pre">&gt;::type</span></tt>.</td>
 148 </tr>
 149 <tr><td><tt class="literal"><span class="pre"><a href="./clear.html" class="identifier">clear</a>&lt;s&gt;::type</span></tt></td>
 150 <td>An empty <tt class="literal"><span class="pre"><a href="./set.html" class="identifier">set</a></span></tt>; see <a class="reference internal" href="./clear.html">clear</a>.</td>
 151 </tr>
 152 </tbody>
 153 </table>
 154 </div>
 155 <div class="section" id="id79">
 156 <h3><a class="subsection-title" href="#example" name="example">Example</a></h3>
 157 <p>Basic <tt class="literal"><span class="pre"><a href="./set.html" class="identifier">set</a></span></tt> invariants:</p>
 158 <pre class="literal-block">
 159 typedef <a href="./set.html" class="identifier">set</a>&lt; int,long,double,<a href="./int.html" class="identifier">int_</a>&lt;5&gt; &gt; s;
 160
 161 <a href="./assert-relation.html" class="identifier">BOOST_MPL_ASSERT_RELATION</a>( <a href="./size.html" class="identifier">size</a>&lt;s&gt;::value, ==, 4 );
 162 <a href="./assert-not.html" class="identifier">BOOST_MPL_ASSERT_NOT</a>(( <a href="./empty.html" class="identifier">empty</a>&lt;s&gt; ));
 163
 164 <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same&lt; <a href="./at.html" class="identifier">at</a>&lt;s,int&gt;::type, int &gt; ));
 165 <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same&lt; <a href="./at.html" class="identifier">at</a>&lt;s,long&gt;::type, long &gt; ));
 166 <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same&lt; <a href="./at.html" class="identifier">at</a>&lt;s,<a href="./int.html" class="identifier">int_</a>&lt;5&gt; &gt;::type, <a href="./int.html" class="identifier">int_</a>&lt;5&gt; &gt; ));
 167 <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same&lt; <a href="./at.html" class="identifier">at</a>&lt;s,char&gt;::type, <a href="./void.html" class="identifier">void_</a> > ));
 168 </pre>
 169 <p id="nonunique-set-example">Constructing a <tt class="literal"><span class="pre"><a href="./set.html" class="identifier">set</a></span></tt> from a list of potentially non-unique types:</p>
 170 <pre class="literal-block">
 171 typedef <a href="./fold.html" class="identifier">fold</a>&lt;
 172       <a href="./vector.html" class="identifier">vector</a>&lt;int,int,long,long&gt;
 173     , set0&lt;&gt;
 174     , <a href="./insert.html" class="identifier">insert</a>&lt;<a href="./placeholders.html" class="identifier">_1</a>,<a href="./placeholders.html" class="identifier">_2</a>&gt;
 175     &gt;::type s;
 176
 177 <a href="./assert-relation.html" class="identifier">BOOST_MPL_ASSERT_RELATION</a>( <a href="./size.html" class="identifier">size</a>&lt;s&gt;::value, ==, 2 );
 178 </pre>
 179 </div>
 180 <div class="section" id="id80">
 181 <h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
 182 <p><a class="reference internal" href="./sequences.html">Sequences</a>, <a class="reference internal" href="./variadic-sequence.html">Variadic Sequence</a>, <a class="reference internal" href="./associative-sequence.html">Associative Sequence</a>, <a class="reference internal" href="./extensible-associative-sequence.html">Extensible Associative Sequence</a>, <a class="reference internal" href="./set-c.html">set_c</a>, <a class="reference internal" href="./map.html">map</a>, <a class="reference internal" href="./vector.html">vector</a></p>
 183 <!-- Sequences/Classes//map |50 -->
 184 </div>
 185 </div>
 186
 187 <div class="footer-separator"></div>
 188 <table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./deque.html" class="navigation-link">Prev</a>&nbsp;<a href="./map.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./deque.html" class="navigation-link">Back</a>&nbsp;<a href="./map.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./classes.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>
 189 <td><div class="copyright-footer"><div class="copyright">Copyright ©  2001-2011 Aleksey Gurtovoy and David Abrahams</div>
 190 Distributed under the Boost Software License, Version 1.0. (See accompanying
 191 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>
 192 </html>