Files
boost_fusion/doc/html/fusion/container/generation/functions/map_tie.html

157 lines
13 KiB
HTML
Raw Normal View History

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>map_tie</title>
<link rel="stylesheet" href="../../../../../../../../doc/html/boostbook.css" type="text/css">
2009-06-13 06:29:32 +00:00
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
<link rel="home" href="../../../../index.html" title="Chapter<65>1.<2E>Fusion 2.0">
<link rel="up" href="../functions.html" title="Functions">
2009-06-13 06:29:32 +00:00
<link rel="previous" href="vector_tie.html" title="vector_tie">
<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:22 +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:22 +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="vector_tie.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">
2009-06-13 06:29:32 +00:00
<div class="titlepage">
<div><div><h5 class="title">
<a name="fusion.container.generation.functions.map_tie"></a><a href="map_tie.html" title="map_tie">map_tie</a>
</h5></div></div>
<div></div>
</div>
<a name="fusion.container.generation.functions.map_tie.description"></a><h6>
2009-06-13 06:29:32 +00:00
<a name="id497955"></a>
<a href="map_tie.html#fusion.container.generation.functions.map_tie.description">Description</a>
</h6>
<p>
2009-06-13 06:29:32 +00:00
Constructs a tie using a <a href="../../map.html" title="map"><tt class="computeroutput"><span class="identifier">map</span></tt></a> sequence.
</p>
<a name="fusion.container.generation.functions.map_tie.synopsis"></a><h6>
2009-06-13 06:29:32 +00:00
<a name="id498002"></a>
<a href="map_tie.html#fusion.container.generation.functions.map_tie.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">K0</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">K1</span><span class="special">,...</span> <span class="keyword">typename</span> <span class="identifier">KN</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">D0</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">D1</span><span class="special">,...</span> <span class="keyword">typename</span> <span class="identifier">DN</span><span class="special">&gt;</span>
2009-06-13 06:29:32 +00:00
<a href="../../map.html" title="map"><tt class="computeroutput"><span class="identifier">map</span></tt></a><span class="special">&lt;</span><a href="../../../support/pair.html" title="pair"><tt class="computeroutput"><span class="identifier">pair</span></tt></a><span class="special">&lt;</span><span class="identifier">K0</span><span class="special">,</span> <span class="identifier">D0</span><span class="special">&amp;&gt;,</span> <a href="../../../support/pair.html" title="pair"><tt class="computeroutput"><span class="identifier">pair</span></tt></a><span class="special">&lt;</span><span class="identifier">K1</span><span class="special">,</span> <span class="identifier">D1</span><span class="special">&amp;&gt;,...</span> <a href="../../../support/pair.html" title="pair"><tt class="computeroutput"><span class="identifier">pair</span></tt></a><span class="special">&lt;</span><span class="identifier">KN</span><span class="special">,</span> <span class="identifier">DN</span><span class="special">&amp;&gt;</span> <span class="special">&gt;</span>
<span class="identifier">map_tie</span><span class="special">(</span><span class="identifier">D0</span><span class="special">&amp;</span> <span class="identifier">d0</span><span class="special">,</span> <span class="identifier">D1</span><span class="special">&amp;</span> <span class="identifier">d1</span><span class="special">...</span> <span class="identifier">DN</span><span class="special">&amp;</span> <span class="identifier">dN</span><span class="special">);</span>
</pre>
<p>
2009-06-13 06:29:32 +00:00
The variadic function accepts <tt class="computeroutput"><span class="number">0</span></tt>
to <tt class="computeroutput"><span class="identifier">FUSION_MAX_MAP_SIZE</span></tt>
elements, where <tt class="computeroutput"><span class="identifier">FUSION_MAX_MAP_SIZE</span></tt>
is a user definable predefined maximum that defaults to <tt class="computeroutput"><span class="number">10</span></tt>, and a corresponding number of key types.
You may define the preprocessor constant <tt class="computeroutput"><span class="identifier">FUSION_MAX_MAP_SIZE</span></tt>
before including any Fusion header to change the default. Example:
</p>
<pre class="programlisting"><span class="preprocessor">#define</span> <span class="identifier">FUSION_MAX_MAP_SIZE</span> <span class="number">20</span>
</pre>
<a name="fusion.container.generation.functions.map_tie.parameters"></a><h6>
2009-06-13 06:29:32 +00:00
<a name="id498469"></a>
<a href="map_tie.html#fusion.container.generation.functions.map_tie.parameters">Parameters</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
2009-06-13 06:29:32 +00:00
<th><p>
Parameter
2009-06-13 06:29:32 +00:00
</p></th>
<th><p>
Requirement
2009-06-13 06:29:32 +00:00
</p></th>
<th><p>
Description
2009-06-13 06:29:32 +00:00
</p></th>
</tr></thead>
<tbody>
<tr>
2009-06-13 06:29:32 +00:00
<td><p>
<tt class="computeroutput"><span class="identifier">K0</span><span class="special">,</span>
<span class="identifier">K1</span><span class="special">,...</span>
2009-06-13 06:29:32 +00:00
<span class="identifier">KN</span></tt>
</p></td>
<td><p>
Any type
2009-06-13 06:29:32 +00:00
</p></td>
<td><p>
The key types associated with each of the <tt class="computeroutput"><span class="identifier">x1</span><span class="special">,</span><span class="identifier">x2</span><span class="special">,...,</span><span class="identifier">xN</span></tt>
values
2009-06-13 06:29:32 +00:00
</p></td>
</tr>
<tr>
2009-06-13 06:29:32 +00:00
<td><p>
<tt class="computeroutput"><span class="identifier">x0</span><span class="special">,</span>
<span class="identifier">x1</span><span class="special">,...</span>
2009-06-13 06:29:32 +00:00
<span class="identifier">xN</span></tt>
</p></td>
<td><p>
Instances of <tt class="computeroutput"><span class="identifier">T0</span><span class="special">,</span> <span class="identifier">T1</span><span class="special">,...</span> <span class="identifier">TN</span></tt>
</p></td>
<td><p>
The arguments to <tt class="computeroutput"><span class="identifier">map_tie</span></tt>
</p></td>
</tr>
</tbody>
</table></div>
<a name="fusion.container.generation.functions.map_tie.expression_semantics"></a><h6>
2009-06-13 06:29:32 +00:00
<a name="id498733"></a>
<a href="map_tie.html#fusion.container.generation.functions.map_tie.expression_semantics">Expression
Semantics</a>
</h6>
<pre class="programlisting"><span class="identifier">map_tie</span><span class="special">&lt;</span><span class="identifier">K0</span><span class="special">,</span> <span class="identifier">K1</span><span class="special">,...</span> <span class="identifier">KN</span><span class="special">&gt;(</span><span class="identifier">x0</span><span class="special">,</span> <span class="identifier">x1</span><span class="special">,...</span> <span class="identifier">xN</span><span class="special">);</span>
</pre>
<p>
2009-06-13 06:29:32 +00:00
<span class="bold"><b>Return type</b></span>: <a href="../../map.html" title="map"><tt class="computeroutput"><span class="identifier">map</span></tt></a>&lt;<a href="../../../support/pair.html" title="pair"><tt class="computeroutput"><span class="identifier">pair</span></tt></a>&lt;K0, D0&amp;&gt;, <a href="../../../support/pair.html" title="pair"><tt class="computeroutput"><span class="identifier">pair</span></tt></a>&lt;K1,
D1&amp;&gt;,... <a href="../../../support/pair.html" title="pair"><tt class="computeroutput"><span class="identifier">pair</span></tt></a>&lt;KN,
DN&amp;&gt; &gt;
</p>
<p>
2009-06-13 06:29:32 +00:00
<span class="bold"><b>Semantics</b></span>: Create a <a href="../../map.html" title="map"><tt class="computeroutput"><span class="identifier">map</span></tt></a> of references from <tt class="computeroutput"><span class="identifier">x0</span><span class="special">,</span> <span class="identifier">x1</span><span class="special">,...</span> <span class="identifier">xN</span></tt> with keys <tt class="computeroutput"><span class="identifier">K0</span><span class="special">,</span> <span class="identifier">K1</span><span class="special">,...</span> <span class="identifier">KN</span></tt>
</p>
<a name="fusion.container.generation.functions.map_tie.header"></a><h6>
2009-06-13 06:29:32 +00:00
<a name="id499015"></a>
<a href="map_tie.html#fusion.container.generation.functions.map_tie.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">generation</span><span class="special">/</span><span class="identifier">map_tie</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">map_tie</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.container.generation.functions.map_tie.example"></a><h6>
2009-06-13 06:29:32 +00:00
<a name="id499181"></a>
<a href="map_tie.html#fusion.container.generation.functions.map_tie.example">Example</a>
</h6>
<pre class="programlisting"><span class="keyword">struct</span> <span class="identifier">int_key</span><span class="special">;</span>
<span class="keyword">struct</span> <span class="identifier">double_key</span><span class="special">;</span>
<span class="special">...</span>
<span class="keyword">int</span> <span class="identifier">i</span> <span class="special">=</span> <span class="number">123</span><span class="special">;</span>
<span class="keyword">double</span> <span class="identifier">d</span> <span class="special">=</span> <span class="number">123.456</span><span class="special">;</span>
<span class="identifier">map_tie</span><span class="special">&lt;</span><span class="identifier">int_key</span><span class="special">,</span> <span class="identifier">double_key</span><span class="special">&gt;(</span><span class="identifier">i</span><span class="special">,</span> <span class="identifier">d</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>
2007-11-14 10:17:09 +00:00
<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>)
2007-11-14 10:17:09 +00:00
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="vector_tie.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>