ceph/src/boost/libs/mpl/doc/refmanual/erase-key.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: erase_key</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="./erase.html" class="navigation-link">Prev</a>&nbsp;<a href="./front.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./erase.html" class="navigation-link">Back</a>&nbsp;<a href="./front.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./intrinsic-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="./sequences.html" class="navigation-link">Sequences</a> / <a href="./intrinsic-metafunctions.html" class="navigation-link">Intrinsic Metafunctions</a> / <a href="./erase-key.html" class="navigation-link">erase_key</a></td>
  13 </tr></table><div class="header-separator"></div>
  14 <div class="section" id="erase-key">
  15 <h1><a class="toc-backref" href="./intrinsic-metafunctions.html#id1433">erase_key</a></h1>
  16 <div class="section" id="id247">
  17 <h3><a class="subsection-title" href="#synopsis" name="synopsis">Synopsis</a></h3>
  18 <pre class="literal-block">
  19 template&lt;
  20       typename AssocSeq
  21     , typename Key
  22     &gt;
  23 struct <a href="./erase-key.html" class="identifier">erase_key</a>
  24 {
  25     typedef <em>unspecified</em> type;
  26 };
  27 </pre>
  28 </div>
  29 <div class="section" id="id248">
  30 <h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
  31 <p>Erases elements associated with the key <tt class="literal"><span class="pre">Key</span></tt> in the <a class="reference internal" href="./extensible-associative-sequence.html">Extensible Associative Sequence</a>
  32 <tt class="literal"><span class="pre">AssocSeq</span></tt> .</p>
  33 </div>
  34 <div class="section" id="id249">
  35 <h3><a class="subsection-title" href="#header" name="header">Header</a></h3>
  36 <pre class="literal-block">
  37 #include &lt;<a href="../../../../boost/mpl/erase_key.hpp" class="header">boost/mpl/erase_key.hpp</a>&gt;
  38 </pre>
  39 </div>
  40 <div class="section" id="id250">
  41 <h3><a class="subsection-title" href="#model-of" name="model-of">Model of</a></h3>
  42 <p><a class="reference internal" href="./tag-dispatched-metafunction.html">Tag Dispatched Metafunction</a></p>
  43 </div>
  44 <div class="section" id="id251">
  45 <h3><a class="subsection-title" href="#parameters" name="parameters">Parameters</a></h3>
  46 <table border="1" class="docutils table">
  47 <colgroup>
  48 <col width="15%" />
  49 <col width="36%" />
  50 <col width="48%" />
  51 </colgroup>
  52 <thead valign="bottom">
  53 <tr><th class="head">Parameter</th>
  54 <th class="head">Requirement</th>
  55 <th class="head">Description</th>
  56 </tr>
  57 </thead>
  58 <tbody valign="top">
  59 <tr><td><tt class="literal"><span class="pre">AssocSeq</span></tt></td>
  60 <td><a class="reference internal" href="./extensible-associative-sequence.html">Extensible Associative Sequence</a></td>
  61 <td>A sequence to erase elements from.</td>
  62 </tr>
  63 <tr><td><tt class="literal"><span class="pre">Key</span></tt></td>
  64 <td>Any type</td>
  65 <td>A key for the elements to be removed.</td>
  66 </tr>
  67 </tbody>
  68 </table>
  69 </div>
  70 <div class="section" id="id252">
  71 <h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
  72 <p>For any <a class="reference internal" href="./extensible-associative-sequence.html">Extensible Associative Sequence</a> <tt class="literal"><span class="pre">s</span></tt>, and arbitrary type <tt class="literal"><span class="pre">key</span></tt>:</p>
  73 <pre class="literal-block">
  74 typedef <a href="./erase-key.html" class="identifier">erase_key</a>&lt;s,key&gt;::type r;
  75 </pre>
  76 <table class="docutils field-list" frame="void" rules="none">
  77 <col class="field-name" />
  78 <col class="field-body" />
  79 <tbody valign="top">
  80 <tr class="field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="./extensible-associative-sequence.html">Extensible Associative Sequence</a>.</td>
  81 </tr>
  82 <tr class="field"><th class="field-name">Semantics:</th><td class="field-body"><tt class="literal"><span class="pre">r</span></tt> is <a class="reference internal" href="./terminology.html#concept-identical">concept-identical</a> and equivalent to <tt class="literal"><span class="pre">s</span></tt> except that
  83 <tt class="literal"><span class="pre"><a href="./has-key.html" class="identifier">has_key</a>&lt;r,k&gt;::value</span> <span class="pre">==</span> <span class="pre">false</span></tt>.</td>
  84 </tr>
  85 <tr class="field"><th class="field-name">Postcondition:</th><td class="field-body"><tt class="literal"><span class="pre"><a href="./size.html" class="identifier">size</a>&lt;r&gt;::value</span> <span class="pre">==</span> <span class="pre"><a href="./size.html" class="identifier">size</a>&lt;s&gt;::value</span> <span class="pre">-</span> <span class="pre">1</span></tt>.</td>
  86 </tr>
  87 </tbody>
  88 </table>
  89 </div>
  90 <div class="section" id="id253">
  91 <h3><a class="subsection-title" href="#complexity" name="complexity">Complexity</a></h3>
  92 <p>Amortized constant time.</p>
  93 </div>
  94 <div class="section" id="id254">
  95 <h3><a class="subsection-title" href="#example" name="example">Example</a></h3>
  96 <pre class="literal-block">
  97 typedef <a href="./map.html" class="identifier">map</a>&lt; <a href="./pair.html" class="identifier">pair</a>&lt;int,unsigned&gt;, <a href="./pair.html" class="identifier">pair</a>&lt;char,long&gt; &gt; m;
  98 typedef <a href="./erase-key.html" class="identifier">erase_key</a>&lt;m,char&gt;::type m1;
  99
 100 <a href="./assert-relation.html" class="identifier">BOOST_MPL_ASSERT_RELATION</a>( <a href="./size.html" class="identifier">size</a>&lt;m1&gt;::type::value, ==, 1 );
 101 <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same&lt; <a href="./at.html" class="identifier">at</a>&lt;m1,char&gt;::type,<a href="./void.html" class="identifier">void_</a> &gt; ));
 102 <a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same&lt; <a href="./at.html" class="identifier">at</a>&lt;m1,int&gt;::type,unsigned > ));
 103 </pre>
 104 </div>
 105 <div class="section" id="id255">
 106 <h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
 107 <p><a class="reference internal" href="./extensible-associative-sequence.html">Extensible Associative Sequence</a>, <a class="reference internal" href="./erase.html">erase</a>, <a class="reference internal" href="./has-key.html">has_key</a>, <a class="reference internal" href="./insert.html">insert</a></p>
 108 <!-- Sequences/Intrinsic Metafunctions//front -->
 109 </div>
 110 </div>
 111
 112 <div class="footer-separator"></div>
 113 <table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./erase.html" class="navigation-link">Prev</a>&nbsp;<a href="./front.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./erase.html" class="navigation-link">Back</a>&nbsp;<a href="./front.html" class="navigation-link">Along</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./intrinsic-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>
 114 <td><div class="copyright-footer"><div class="copyright">Copyright ©  2001-2009 Aleksey Gurtovoy and David Abrahams</div>
 115 Distributed under the Boost Software License, Version 1.0. (See accompanying
 116 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>
 117 </html>