feedc0de/boost_fusion
1
0
Fork 0
forked from boostorg/fusion
Code Pull Requests Activity
Files
d150ba849864485e614b259ff69dae0c1931aa44
boost_fusion/doc/html/fusion/container/generation/functions/map_tie.html
T
Daniel James 813930aee6 Rebuild a lot of documentation. 
[SVN r43650]
2008-03-16 11:38:32 +00:00

177 lines
14 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<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">
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="../../../../index.html" title="Chapter 1. Fusion 2.0">
<link rel="up" href="../functions.html" title="Functions">
<link rel="prev" 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>
<td align="center"><a href="../../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/people/people.htm">People</a></td>
<td align="center"><a href="http://www.boost.org/more/faq.htm">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">
<div class="titlepage"><div><div><h5 class="title">
<a name="fusion.container.generation.functions.map_tie"></a><a class="link" href="map_tie.html" title="map_tie">map_tie</a>
</h5></div></div></div>
<a name="fusion.container.generation.functions.map_tie.description"></a><h6>
<a name="id2716566"></a>
<a class="link" href="map_tie.html#fusion.container.generation.functions.map_tie.description">Description</a>
</h6>
<p>
Constructs a tie using a <a class="link" href="../../map.html" title="map"><code class="computeroutput"><span class="identifier">map</span></code></a> sequence.
</p>
<a name="fusion.container.generation.functions.map_tie.synopsis"></a><h6>
<a name="id2716608"></a>
<a class="link" 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>
<a class="link" href="../../map.html" title="map"><code class="computeroutput"><span class="identifier">map</span></code></a><span class="special">&lt;</span><a class="link" href="../../../support/pair.html" title="pair"><code class="computeroutput"><span class="identifier">pair</span></code></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 class="link" href="../../../support/pair.html" title="pair"><code class="computeroutput"><span class="identifier">pair</span></code></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 class="link" href="../../../support/pair.html" title="pair"><code class="computeroutput"><span class="identifier">pair</span></code></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>
The variadic function accepts <code class="computeroutput"><span class="number">0</span></code>
to <code class="computeroutput"><span class="identifier">FUSION_MAX_MAP_SIZE</span></code>
elements, where <code class="computeroutput"><span class="identifier">FUSION_MAX_MAP_SIZE</span></code>
is a user definable predefined maximum that defaults to <code class="computeroutput"><span class="number">10</span></code>, and a corresponding number of key types.
You may define the preprocessor constant <code class="computeroutput"><span class="identifier">FUSION_MAX_MAP_SIZE</span></code>
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>
<a name="id2717033"></a>
<a class="link" 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>
<th>
<p>
Parameter
</p>
</th>
<th>
<p>
Requirement
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<code 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></code>
</p>
</td>
<td>
<p>
Any type
</p>
</td>
<td>
<p>
The key types associated with each of the <code 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></code>
values
</p>
</td>
</tr>
<tr>
<td>
<p>
<code 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></code>
</p>
</td>
<td>
<p>
Instances of <code 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></code>
</p>
</td>
<td>
<p>
The arguments to <code class="computeroutput"><span class="identifier">map_tie</span></code>
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="fusion.container.generation.functions.map_tie.expression_semantics"></a><h6>
<a name="id2717271"></a>
<a class="link" 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>
<span class="bold"><strong>Return type</strong></span>: <a class="link" href="../../map.html" title="map"><code class="computeroutput"><span class="identifier">map</span></code></a>&lt;<a class="link" href="../../../support/pair.html" title="pair"><code class="computeroutput"><span class="identifier">pair</span></code></a>&lt;K0, D0&amp;&gt;, <a class="link" href="../../../support/pair.html" title="pair"><code class="computeroutput"><span class="identifier">pair</span></code></a>&lt;K1,
D1&amp;&gt;,... <a class="link" href="../../../support/pair.html" title="pair"><code class="computeroutput"><span class="identifier">pair</span></code></a>&lt;KN,
DN&amp;&gt; &gt;
</p>
<p>
<span class="bold"><strong>Semantics</strong></span>: Create a <a class="link" href="../../map.html" title="map"><code class="computeroutput"><span class="identifier">map</span></code></a> of references from <code 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></code> with keys <code 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></code>
</p>
<a name="fusion.container.generation.functions.map_tie.header"></a><h6>
<a name="id2717525"></a>
<a class="link" 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>
<a name="id2717677"></a>
<a class="link" 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>
<td align="right"><div class="copyright-footer">Copyright © 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="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>
View Git Blame Copy Permalink