Files
boost_fusion/doc/html/fusion/container/conversion/functions/as_map.html

146 lines
9.8 KiB
HTML
Raw Normal View History

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>as_map</title>
<link rel="stylesheet" href="../../../../../../../../doc/html/boostbook.css" type="text/css">
2008-07-08 02:43:21 +00:00
<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
<link rel="start" href="../../../../index.html" title="Chapter<65>1.<2E>Fusion 2.0">
<link rel="up" href="../functions.html" title="Functions">
<link rel="prev" href="as_set.html" title="as_set">
<link rel="next" href="../metafunctions.html" title="Metafunctions">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
2008-07-17 23:59:40 +00:00
<td align="center"><a href="../../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../libraries.htm">Libraries</a></td>
2008-07-17 23:59:40 +00:00
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="as_set.html"><img src="../../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../functions.html"><img src="../../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../metafunctions.html"><img src="../../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h5 class="title">
2008-07-08 02:43:21 +00:00
<a name="fusion.container.conversion.functions.as_map"></a><a href="as_map.html" title="as_map">as_map</a></h5></div></div></div>
<a name="fusion.container.conversion.functions.as_map.description"></a><h6>
2008-07-22 02:06:42 +00:00
<a name="id559089"></a>
2008-07-08 02:43:21 +00:00
<a href="as_map.html#fusion.container.conversion.functions.as_map.description">Description</a>
</h6>
<p>
2008-07-08 02:43:21 +00:00
Convert a fusion sequence to a <a href="../../map.html" title="map"><tt class="computeroutput"><span class="identifier">map</span></tt></a>.
</p>
<a name="fusion.container.conversion.functions.as_map.synopsis"></a><h6>
2008-07-22 02:06:42 +00:00
<a name="id559137"></a>
2008-07-08 02:43:21 +00:00
<a href="as_map.html#fusion.container.conversion.functions.as_map.synopsis">Synopsis</a>
</h6>
<pre class="programlisting">
<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Sequence</span><span class="special">&gt;</span>
<span class="keyword">typename</span> <span class="identifier">result_of</span><span class="special">::</span><span class="identifier">as_map</span><span class="special">&lt;</span><span class="identifier">Sequence</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="identifier">as_map</span><span class="special">(</span><span class="identifier">Sequence</span><span class="special">&amp;</span> <span class="identifier">seq</span><span class="special">);</span>
<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Sequence</span><span class="special">&gt;</span>
<span class="keyword">typename</span> <span class="identifier">result_of</span><span class="special">::</span><span class="identifier">as_map</span><span class="special">&lt;</span><span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="identifier">as_map</span><span class="special">(</span><span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">seq</span><span class="special">);</span>
</pre>
<a name="fusion.container.conversion.functions.as_map.parameters"></a><h6>
2008-07-22 02:06:42 +00:00
<a name="id559395"></a>
2008-07-08 02:43:21 +00:00
<a href="as_map.html#fusion.container.conversion.functions.as_map.parameters">Parameters</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Parameter
</p>
</th>
<th>
<p>
Requirement
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
2008-07-08 02:43:21 +00:00
<tt class="computeroutput"><span class="identifier">seq</span></tt>
</p>
</td>
<td>
<p>
An instance of Sequence
</p>
</td>
<td>
<p>
The sequence to convert.
</p>
</td>
</tr></tbody>
</table></div>
<a name="fusion.container.conversion.functions.as_map.expression_semantics"></a><h6>
2008-07-22 02:06:42 +00:00
<a name="id559503"></a>
2008-07-08 02:43:21 +00:00
<a href="as_map.html#fusion.container.conversion.functions.as_map.expression_semantics">Expression
Semantics</a>
</h6>
<pre class="programlisting">
<span class="identifier">as_map</span><span class="special">(</span><span class="identifier">seq</span><span class="special">);</span>
</pre>
<p>
2008-07-08 02:43:21 +00:00
<span class="bold"><b>Return type</b></span>: <a href="../metafunctions/as_map.html" title="as_map"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">as_map</span></tt></a><tt class="computeroutput"><span class="special">&lt;</span><span class="identifier">Sequence</span><span class="special">&gt;::</span><span class="identifier">type</span></tt>
</p>
<p>
2008-07-08 02:43:21 +00:00
<span class="bold"><b>Semantics</b></span>: Convert a fusion sequence,
<tt class="computeroutput"><span class="identifier">seq</span></tt>, to a <a href="../../map.html" title="map"><tt class="computeroutput"><span class="identifier">map</span></tt></a>.
</p>
<p>
2008-07-08 02:43:21 +00:00
<span class="bold"><b>Precondition</b></span>: The elements of the sequence
are assumed to be __fusion<span class="underline">pair</span>_s.
2008-07-08 02:43:21 +00:00
There may be no duplicate <a href="../../../support/pair.html" title="pair"><tt class="computeroutput"><span class="identifier">fusion</span><span class="special">::</span><span class="identifier">pair</span></tt></a> key types.
</p>
<a name="fusion.container.conversion.functions.as_map.header"></a><h6>
2008-07-22 02:06:42 +00:00
<a name="id559710"></a>
2008-07-08 02:43:21 +00:00
<a href="as_map.html#fusion.container.conversion.functions.as_map.header">Header</a>
</h6>
<pre class="programlisting">
<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">fusion</span><span class="special">/</span><span class="identifier">container</span><span class="special">/</span><span class="identifier">map</span><span class="special">/</span><span class="identifier">convert</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">fusion</span><span class="special">/</span><span class="identifier">include</span><span class="special">/</span><span class="identifier">as_map</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.container.conversion.functions.as_map.example"></a><h6>
2008-07-22 02:06:42 +00:00
<a name="id559879"></a>
2008-07-08 02:43:21 +00:00
<a href="as_map.html#fusion.container.conversion.functions.as_map.example">Example</a>
</h6>
<pre class="programlisting">
2008-07-08 02:43:21 +00:00
<span class="identifier">as_map</span><span class="special">(</span><a href="../../generation/functions/make_vector.html" title="make_vector"><tt class="computeroutput"><span class="identifier">make_vector</span></tt></a><span class="special">(</span>
<a href="../../../support/pair.html" title="pair"><tt class="computeroutput"><span class="identifier">make_pair</span></tt></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&gt;(</span><span class="char">'X'</span><span class="special">)</span>
<span class="special">,</span> <a href="../../../support/pair.html" title="pair"><tt class="computeroutput"><span class="identifier">make_pair</span></tt></a><span class="special">&lt;</span><span class="keyword">double</span><span class="special">&gt;(</span><span class="string">"Men"</span><span class="special">)))</span>
</pre>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright <20> 2001-2007 Joel de Guzman, Dan Marsden, Tobias
Schwinger<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="as_set.html"><img src="../../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../functions.html"><img src="../../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="../metafunctions.html"><img src="../../../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>