Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_33_1/libs/mpl/doc/refmanual/map.html @ 12

Last change on this file since 12 was 12, checked in by landauf, 18 years ago

added boost
File size: 15.6 KB
Line 
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.3.6: http://docutils.sourceforge.net/" />
7<title>The MPL Reference Manual: map</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="./set.html" class="navigation-link">Prev</a>&nbsp;<a href="./range-c.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./set.html" class="navigation-link">Back</a>&nbsp;<a href="./range-c.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="./map.html" class="navigation-link">map</a></td>
13</tr></table><div class="header-separator"></div>
14<div class="section" id="map">
15<h1><a class="toc-backref" href="./classes.html#id339" name="map">map</a></h1>
16<div class="section" id="map-description">
17<h3><a class="subsection-title" href="#description" name="description">Description</a></h3>
18<p><tt class="literal"><span class="pre"><a href="./map.html" class="identifier">map</a></span></tt> is a <a class="reference" href="./variadic-sequence.html">variadic</a>, <a class="reference" href="./associative-sequence.html">associative</a>, <a class="reference" href="./extensible-associative.html">extensible</a> sequence of type pairs that
19supports constant-time insertion and removal of elements, and testing for membership.
20A <tt class="literal"><span class="pre"><a href="./map.html" class="identifier">map</a></span></tt> may contain at most one element for each key.</p>
21</div>
22<div class="section" id="map-header">
23<h3><a class="subsection-title" href="#header" name="header">Header</a></h3>
24<table border="1" class="table">
25<colgroup>
26<col width="26%" />
27<col width="74%" />
28</colgroup>
29<thead valign="bottom">
30<tr><th>Sequence form</th>
31<th>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/map.hpp" class="header">boost/mpl/map.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/map/map</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="map-model-of">
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" href="./variadic-sequence.html">Variadic Sequence</a></li>
48<li><a class="reference" href="./associative-sequence.html">Associative Sequence</a></li>
49<li><a class="reference" href="./extensible-associative.html">Extensible Associative Sequence</a></li>
50</ul>
51</div>
52<div class="section" id="map-expression-semantics">
53<h3><a class="subsection-title" href="#expression-semantics" name="expression-semantics">Expression semantics</a></h3>
54<p>In the following table and subsequent specifications, <tt class="literal"><span class="pre">m</span></tt> is an instance of <tt class="literal"><span class="pre"><a href="./map.html" class="identifier">map</a></span></tt>,
55<tt class="literal"><span class="pre">pos</span></tt> is an iterator into <tt class="literal"><span class="pre">m</span></tt>, <tt class="literal"><span class="pre">x</span></tt> and <em>p</em><sub>1</sub>,<em>p</em><sub>2</sub>,... <em>p</em><sub>n</sub> are <tt class="literal"><span class="pre"><a href="./pair.html" class="identifier">pair</a></span></tt>s, and <tt class="literal"><span class="pre">k</span></tt> is an arbitrary type.</p>
56<table border="1" class="table">
57<colgroup>
58<col width="40%" />
59<col width="60%" />
60</colgroup>
61<thead valign="bottom">
62<tr><th>Expression</th>
63<th>Semantics</th>
64</tr>
65</thead>
66<tbody valign="top">
67<tr><td><pre class="first last literal-block">
68<a href="./map.html" class="identifier">map</a>&lt;<em>p</em><sub>1</sub>,<em>p</em><sub>2</sub>,... <em>p</em><sub>n</sub>&gt;
69<a href="./map.html" class="identifier">map</a><em>n</em>&lt;<em>p</em><sub>1</sub>,<em>p</em><sub>2</sub>,... <em>p</em><sub>n</sub>&gt;
70</pre>
71</td>
72<td><tt class="literal"><span class="pre"><a href="./map.html" class="identifier">map</a></span></tt> of elements <em>p</em><sub>1</sub>,<em>p</em><sub>2</sub>,... <em>p</em><sub>n</sub>; see
73<a class="reference" href="./variadic-sequence.html">Variadic Sequence</a>.</td>
74</tr>
75<tr><td><pre class="first last literal-block">
76<a href="./map.html" class="identifier">map</a>&lt;<em>p</em><sub>1</sub>,<em>p</em><sub>2</sub>,... <em>p</em><sub>n</sub>&gt;::type
77<a href="./map.html" class="identifier">map</a><em>n</em>&lt;<em>p</em><sub>1</sub>,<em>p</em><sub>2</sub>,... <em>p</em><sub>n</sub>&gt;::type
78</pre>
79</td>
80<td>Identical to <tt class="literal"><span class="pre"><a href="./map.html" class="identifier">map</a></span></tt><em>n</em><tt class="literal"><span class="pre">&lt;</span></tt><em>p</em><sub>1</sub>,<em>p</em><sub>2</sub>,... <em>p</em><sub>n</sub><tt class="literal"><span class="pre">&gt;</span></tt>;
81see <a class="reference" href="./variadic-sequence.html">Variadic Sequence</a>.</td>
82</tr>
83<tr><td><tt class="literal"><span class="pre"><a href="./begin.html" class="identifier">begin</a>&lt;m&gt;::type</span></tt></td>
84<td>An iterator pointing to the beginning of <tt class="literal"><span class="pre">m</span></tt>;
85see <a class="reference" href="./associative-sequence.html">Associative Sequence</a>.</td>
86</tr>
87<tr><td><tt class="literal"><span class="pre"><a href="./end.html" class="identifier">end</a>&lt;m&gt;::type</span></tt></td>
88<td>An iterator pointing to the end of <tt class="literal"><span class="pre">m</span></tt>;
89see <a class="reference" href="./associative-sequence.html">Associative Sequence</a>.</td>
90</tr>
91<tr><td><tt class="literal"><span class="pre"><a href="./size.html" class="identifier">size</a>&lt;m&gt;::type</span></tt></td>
92<td>The size of <tt class="literal"><span class="pre">m</span></tt>; see <a class="reference" href="./associative-sequence.html">Associative Sequence</a>.</td>
93</tr>
94<tr><td><tt class="literal"><span class="pre"><a href="./empty.html" class="identifier">empty</a>&lt;m&gt;::type</span></tt></td>
95<td>A boolean <a class="reference" href="./integral-constant.html">Integral Constant</a> <tt class="literal"><span class="pre">c</span></tt> such that
96<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">m</span></tt> is empty; see
97<a class="reference" href="./associative-sequence.html">Associative Sequence</a>.</td>
98</tr>
99<tr><td><tt class="literal"><span class="pre"><a href="./front.html" class="identifier">front</a>&lt;m&gt;::type</span></tt></td>
100<td>The first element in <tt class="literal"><span class="pre">m</span></tt>; see
101<a class="reference" href="./associative-sequence.html">Associative Sequence</a>.</td>
102</tr>
103<tr><td><tt class="literal"><span class="pre"><a href="./has-key.html" class="identifier">has_key</a>&lt;m,k&gt;::type</span></tt></td>
104<td>Queries the presence of elements with the key <tt class="literal"><span class="pre">k</span></tt> in
105<tt class="literal"><span class="pre">m</span></tt>; see <a class="reference" href="./associative-sequence.html">Associative Sequence</a>.</td>
106</tr>
107<tr><td><tt class="literal"><span class="pre"><a href="./count.html" class="identifier">count</a>&lt;m,k&gt;::type</span></tt></td>
108<td>The number of elements with the key <tt class="literal"><span class="pre">k</span></tt> in <tt class="literal"><span class="pre">m</span></tt>;
109see <a class="reference" href="./associative-sequence.html">Associative Sequence</a>.</td>
110</tr>
111<tr><td><tt class="literal"><span class="pre"><a href="./order.html" class="identifier">order</a>&lt;m,k&gt;::type</span></tt></td>
112<td>A unique unsigned <a class="reference" href="./integral-constant.html">Integral Constant</a> associated with
113the key <tt class="literal"><span class="pre">k</span></tt> in <tt class="literal"><span class="pre">m</span></tt>; see <a class="reference" href="./associative-sequence.html">Associative Sequence</a>.</td>
114</tr>
115<tr><td><pre class="first last literal-block">
116<a href="./at.html" class="identifier">at</a>&lt;m,k&gt;::type
117<a href="./at.html" class="identifier">at</a>&lt;m,k,default&gt;::type
118</pre>
119</td>
120<td>The element associated with the key <tt class="literal"><span class="pre">k</span></tt> in
121<tt class="literal"><span class="pre">m</span></tt>; see <a class="reference" href="./associative-sequence.html">Associative Sequence</a>.</td>
122</tr>
123<tr><td><tt class="literal"><span class="pre"><a href="./key-type.html" class="identifier">key_type</a>&lt;m,x&gt;::type</span></tt></td>
124<td>Identical to <tt class="literal"><span class="pre">x::first</span></tt>; see <a class="reference" href="./associative-sequence.html">Associative Sequence</a>.</td>
125</tr>
126<tr><td><tt class="literal"><span class="pre"><a href="./value-type.html" class="identifier">value_type</a>&lt;m,x&gt;::type</span></tt></td>
127<td>Identical to <tt class="literal"><span class="pre">x::second</span></tt>; see <a class="reference" href="./associative-sequence.html">Associative Sequence</a>.</td>
128</tr>
129<tr><td><tt class="literal"><span class="pre"><a href="./insert.html" class="identifier">insert</a>&lt;m,x&gt;::type</span></tt></td>
130<td><p class="first">A new <tt class="literal"><span class="pre"><a href="./map.html" class="identifier">map</a></span></tt> equivalent to <tt class="literal"><span class="pre">m</span></tt> except that</p>
131<pre class="literal-block">
132<a href="./at.html" class="identifier">at</a>&lt; t, <a href="./key-type.html" class="identifier">key_type</a>&lt;m,x&gt;::type &gt;::type
133</pre>
134<p class="last">is identical to <tt class="literal"><span class="pre"><a href="./value-type.html" class="identifier">value_type</a>&lt;m,x&gt;::type</span></tt>.</p>
135</td>
136</tr>
137<tr><td><tt class="literal"><span class="pre"><a href="./insert.html" class="identifier">insert</a>&lt;m,pos,x&gt;::type</span></tt></td>
138<td>Equivalent to <tt class="literal"><span class="pre"><a href="./insert.html" class="identifier">insert</a>&lt;m,x&gt;::type</span></tt>; <tt class="literal"><span class="pre">pos</span></tt> is ignored.</td>
139</tr>
140<tr><td><tt class="literal"><span class="pre"><a href="./erase-key.html" class="identifier">erase_key</a>&lt;m,k&gt;::type</span></tt></td>
141<td>A new <tt class="literal"><span class="pre"><a href="./map.html" class="identifier">map</a></span></tt> equivalent to <tt class="literal"><span class="pre">m</span></tt> except that
142<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>
143</tr>
144<tr><td><tt class="literal"><span class="pre"><a href="./erase.html" class="identifier">erase</a>&lt;m,pos&gt;::type</span></tt></td>
145<td>Equivalent to <tt class="literal"><span class="pre"><a href="./erase.html" class="identifier">erase</a>&lt;m,</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>
146</tr>
147<tr><td><tt class="literal"><span class="pre"><a href="./clear.html" class="identifier">clear</a>&lt;m&gt;::type</span></tt></td>
148<td>An empty <tt class="literal"><span class="pre"><a href="./map.html" class="identifier">map</a></span></tt>; see <a class="refentry reference" href="./clear.html"><tt class="refentry literal"><span class="pre">clear</span></tt></a>.</td>
149</tr>
150</tbody>
151</table>
152</div>
153<div class="section" id="map-example">
154<h3><a class="subsection-title" href="#example" name="example">Example</a></h3>
155<pre class="literal-block">
156typedef <a href="./map.html" class="identifier">map</a>&lt;
157      <a href="./pair.html" class="identifier">pair</a>&lt;int,unsigned&gt;
158    , <a href="./pair.html" class="identifier">pair</a>&lt;char,unsigned char&gt;
159    , <a href="./pair.html" class="identifier">pair</a>&lt;<a href="./long.html" class="identifier">long_</a>&lt;5&gt;,char[17]&gt;
160    , <a href="./pair.html" class="identifier">pair</a>&lt;int[42],bool&gt;
161    &gt; m;
162
163<a href="./assert-relation.html" class="identifier">BOOST_MPL_ASSERT_RELATION</a>( <a href="./size.html" class="identifier">size</a>&lt;m&gt;::value, ==, 4 );
164<a href="./assert-not.html" class="identifier">BOOST_MPL_ASSERT_NOT</a>(( <a href="./empty.html" class="identifier">empty</a>&lt;m&gt; ));
165
166<a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same&lt; <a href="./at.html" class="identifier">at</a>&lt;m,int&gt;::type, unsigned &gt; ));
167<a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same&lt; <a href="./at.html" class="identifier">at</a>&lt;m,<a href="./long.html" class="identifier">long_</a>&lt;5&gt; &gt;::type, char[17] &gt; ));
168<a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same&lt; <a href="./at.html" class="identifier">at</a>&lt;m,int[42]&gt;::type, bool &gt; ));
169<a href="./assert.html" class="identifier">BOOST_MPL_ASSERT</a>(( is_same&lt; <a href="./at.html" class="identifier">at</a>&lt;m,long&gt;::type, <a href="./void.html" class="identifier">void_</a> > ));
170</pre>
171</div>
172<div class="section" id="map-see-also">
173<h3><a class="subsection-title" href="#see-also" name="see-also">See also</a></h3>
174<p><a class="reference" href="./sequences.html">Sequences</a>, <a class="reference" href="./variadic-sequence.html">Variadic Sequence</a>, <a class="reference" href="./associative-sequence.html">Associative Sequence</a>, <a class="reference" href="./extensible-associative.html">Extensible Associative Sequence</a>, <a class="refentry reference" href="./set.html"><tt class="refentry literal"><span class="pre">set</span></tt></a>, <a class="refentry reference" href="./vector.html"><tt class="refentry literal"><span class="pre">vector</span></tt></a></p>
175<!-- modtime: November 15, 2004 01:17:29 +0000 -->
176<!-- Sequences/Classes//range_c |60 -->
177</div>
178</div>
179
180<div class="footer-separator"></div>
181<table class="footer"><tr class="footer"><td class="header-group navigation-bar"><span class="navigation-group"><a href="./set.html" class="navigation-link">Prev</a>&nbsp;<a href="./range-c.html" class="navigation-link">Next</a></span><span class="navigation-group-separator">&nbsp;|&nbsp;</span><span class="navigation-group"><a href="./set.html" class="navigation-link">Back</a>&nbsp;<a href="./range-c.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>
182</tr></table></body>
183</html>
Note: See TracBrowser for help on using the repository browser.