feedc0de/boost_fusion
1
0
Fork 0
forked from boostorg/fusion
Code Pull Requests Activity

adding fusion docs and tests

Browse Source 
[SVN r34920]
This commit is contained in:
Joel de Guzman
2006-08-22 15:57:13 +00:00
parent 75b9d13a88
commit c31253d8c1
351 changed files with 42280 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

236
doc/html/fusion/sequences/containers/cons.html Normal file
View File

@ -0,0 +1,236 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>cons</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<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="../containers.html" title="Containers">
<link rel="prev" href="vector.html" title="vector">
<link rel="next" href="list.html" title="list">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../../../libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="vector.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../containers.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="list.html"><img src="../../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="fusion.sequences.containers.cons"></a><a href="cons.html" title="cons">cons</a></h4></div></div></div>
<a name="fusion.sequences.containers.cons.description"></a><h5>
<a name="id479743"></a>
<a href="cons.html#fusion.sequences.containers.cons.description">Description</a>
</h5>
<p>
<tt class="computeroutput"><span class="identifier">cons</span></tt> is a simple <a href="../concepts/forward_sequence.html" title="Forward
Sequence">Forward Sequence</a>.
It is a lisp style recursive list structure where <tt class="computeroutput"><span class="identifier">car</span></tt>
is the <span class="emphasis"><em>head</em></span> and <tt class="computeroutput"><span class="identifier">cdr</span></tt>
is the <span class="emphasis"><em>tail</em></span>: usually another cons structure or <tt class="computeroutput"><span class="identifier">nil</span></tt>: the empty list. Fusion's <a href="list.html" title="list"><tt class="computeroutput"><span class="identifier">list</span></tt></a> is built on top of this more
primitive data structure. It is more efficient than <a href="vector.html" title="vector"><tt class="computeroutput"><span class="identifier">vector</span></tt></a> when the target sequence
is constructed piecemeal (a data at a time). The runtime cost of access
to each element is peculiarly constant (see <a href="../../notes.html#fusion.notes.recursive_inlined_functions">Recursive
Inlined Functions</a>).
</p>
<a name="fusion.sequences.containers.cons.header"></a><h5>
<a name="id479880"></a>
<a href="cons.html#fusion.sequences.containers.cons.header">Header</a>
</h5>
<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">sequence</span><span class="special">/</span><span class="identifier">container</span><span class="special">/</span><span class="identifier">list</span><span class="special">/</span><span class="identifier">cons</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.sequences.containers.cons.synopsis"></a><h5>
<a name="id479994"></a>
<a href="cons.html#fusion.sequences.containers.cons.synopsis">Synopsis</a>
</h5>
<pre class="programlisting">
<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Car</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Cdr</span> <span class="special">=</span> <span class="identifier">nil</span><span class="special">&gt;</span>
<span class="keyword">struct</span> <span class="identifier">cons</span><span class="special">;</span>
</pre>
<a name="fusion.sequences.containers.cons.template_parameters"></a><h5>
<a name="id480102"></a>
<a href="cons.html#fusion.sequences.containers.cons.template_parameters">Template
parameters</a>
</h5>
<div class="informaltable">
<h4>
<a name="id480124"></a>
</h4>
<table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Parameter</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody>
<tr>
<td><tt class="computeroutput"><span class="identifier">Car</span></tt></td>
<td>Head
type</td>
<td><EFBFBD></td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">Cdr</span></tt></td>
<td>Tail
type</td>
<td><tt class="computeroutput"><span class="identifier">nil</span></tt></td>
</tr>
</tbody>
</table>
</div>
<a name="fusion.sequences.containers.cons.model_of"></a><h5>
<a name="id480213"></a>
<a href="cons.html#fusion.sequences.containers.cons.model_of">Model of</a>
</h5>
<div class="itemizedlist"><ul type="disc"><li><a href="../concepts/forward_sequence.html" title="Forward
Sequence">Forward Sequence</a></li></ul></div>
<div class="variablelist">
<p class="title"><b>Notation</b></p>
<dl>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">nil</span></tt></span></dt>
<dd>
An empty <tt class="computeroutput"><span class="identifier">cons</span></tt>
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">C</span></tt></span></dt>
<dd>
A <tt class="computeroutput"><span class="identifier">cons</span></tt> type
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">l</span></tt>,
<tt class="computeroutput"><span class="identifier">l2</span></tt></span></dt>
<dd>
Instances of <tt class="computeroutput"><span class="identifier">cons</span></tt>
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">car</span></tt></span></dt>
<dd>
An arbitrary data
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">cdr</span></tt></span></dt>
<dd>
Another <tt class="computeroutput"><span class="identifier">cons</span></tt> list
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">s</span></tt></span></dt>
<dd>
A <a href="../concepts/forward_sequence.html" title="Forward
Sequence">Forward
Sequence</a>
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">N</span></tt></span></dt>
<dd>
An Integral Constant
</dd>
</dl>
</div>
<a name="fusion.sequences.containers.cons.expression_semantics"></a><h5>
<a name="id480445"></a>
<a href="cons.html#fusion.sequences.containers.cons.expression_semantics">Expression
Semantics</a>
</h5>
<p>
Semantics of an expression is defined only where it differs from, or is
not defined in <a href="../concepts/forward_sequence.html" title="Forward
Sequence">Forward
Sequence</a>.
</p>
<div class="informaltable">
<h4>
<a name="id480482"></a>
</h4>
<table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>Expression</th>
<th>Semantics</th>
</tr></thead>
<tbody>
<tr>
<td><tt class="computeroutput"><span class="identifier">nil</span><span class="special">()</span></tt></td>
<td>Creates
an empty list.</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">C</span><span class="special">()</span></tt></td>
<td>Creates
a cons with default constructed elements.</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">C</span><span class="special">(</span><span class="identifier">car</span><span class="special">)</span></tt></td>
<td>Creates
a cons with <tt class="computeroutput"><span class="identifier">car</span></tt> head
and default constructed tail.</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">C</span><span class="special">(</span><span class="identifier">car</span><span class="special">,</span><EFBFBD><span class="identifier">cdr</span><span class="special">)</span></tt></td>
<td>Creates
a cons with <tt class="computeroutput"><span class="identifier">car</span></tt> head
and <tt class="computeroutput"><span class="identifier">cdr</span></tt> tail.</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">C</span><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></tt></td>
<td>Copy
constructs a cons from a <a href="../concepts/forward_sequence.html" title="Forward
Sequence">Forward
Sequence</a>, <tt class="computeroutput"><span class="identifier">s</span></tt>.</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">l</span><EFBFBD><span class="special">=</span><EFBFBD><span class="identifier">s</span></tt></td>
<td>Assigns to a cons,
<tt class="computeroutput"><span class="identifier">l</span></tt>, from a <a href="../concepts/forward_sequence.html" title="Forward
Sequence">Forward
Sequence</a>, <tt class="computeroutput"><span class="identifier">s</span></tt>.</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../intrinsics/functions/at.html" title="at"><tt class="computeroutput"><span class="identifier">at</span></tt></a><span class="special">&lt;</span><span class="identifier">N</span><span class="special">&gt;(</span><span class="identifier">l</span><span class="special">)</span></tt></td>
<td>The
Nth element from the beginning of the sequence; see <a href="../intrinsics/functions/at.html" title="at"><tt class="computeroutput"><span class="identifier">at</span></tt></a>.</td>
</tr>
</tbody>
</table>
</div>
<p class="blurb">
<span class="inlinemediaobject"><img src="../../../images/note.png" alt="note"></span><EFBFBD><tt class="computeroutput"><a href="../intrinsics/functions/at.html" title="at"><tt class="computeroutput"><span class="identifier">at</span></tt></a><span class="special">&lt;</span><span class="identifier">N</span><span class="special">&gt;(</span><span class="identifier">l</span><span class="special">)</span></tt> is
provided for convenience and compatibility with the original <a href="http://www.boost.org/libs/tuple/doc/tuple_users_guide.html" target="_top">Boost.Tuple</a>
library, despite <tt class="computeroutput"><span class="identifier">cons</span></tt> being
a <a href="../concepts/forward_sequence.html" title="Forward
Sequence">Forward Sequence</a>
only (<tt class="computeroutput"><span class="identifier">at</span></tt> is supposed to
be a <a href="../concepts/random_access_sequence.html" title="Random
Access Sequence">Random
Access Sequence</a> requirement). The runtime complexity of <a href="../intrinsics/functions/at.html" title="at"><tt class="computeroutput"><span class="identifier">at</span></tt></a> is constant (see <a href="../../notes.html#fusion.notes.recursive_inlined_functions">Recursive
Inlined Functions</a>).
</p>
<a name="fusion.sequences.containers.cons.example"></a><h5>
<a name="id480996"></a>
<a href="cons.html#fusion.sequences.containers.cons.example">Example</a>
</h5>
<pre class="programlisting">
<span class="identifier">cons</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="identifier">cons</span><span class="special">&lt;</span><span class="keyword">float</span><span class="special">&gt;</span> <span class="special">&gt;</span> <span class="identifier">l</span><span class="special">(</span><span class="number">12</span><span class="special">,</span> <span class="identifier">cons</span><span class="special">&lt;</span><span class="keyword">float</span><span class="special">&gt;(</span><span class="number">5.5f</span><span class="special">));</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <a href="../intrinsics/functions/at.html" title="at"><tt class="computeroutput"><span class="identifier">at</span></tt></a><span class="special">&lt;</span><span class="number">0</span><span class="special">&gt;(</span><span class="identifier">l</span><span class="special">)</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <a href="../intrinsics/functions/at.html" title="at"><tt class="computeroutput"><span class="identifier">at</span></tt></a><span class="special">&lt;</span><span class="number">1</span><span class="special">&gt;(</span><span class="identifier">l</span><span class="special">)</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</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"><small>Copyright <20> 2001-2005 Joel de Guzman, Dan Marsden</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="vector.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../containers.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="list.html"><img src="../../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

228
doc/html/fusion/sequences/containers/list.html Normal file
View File

@ -0,0 +1,228 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>list</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<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="../containers.html" title="Containers">
<link rel="prev" href="cons.html" title="cons">
<link rel="next" href="set.html" title="set">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../../../libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="cons.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../containers.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="set.html"><img src="../../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="fusion.sequences.containers.list"></a><a href="list.html" title="list">list</a></h4></div></div></div>
<a name="fusion.sequences.containers.list.description"></a><h5>
<a name="id481327"></a>
<a href="list.html#fusion.sequences.containers.list.description">Description</a>
</h5>
<p>
<tt class="computeroutput"><span class="identifier">list</span></tt> is a <a href="../concepts/forward_sequence.html" title="Forward
Sequence">Forward
Sequence</a> of heterogenous typed data built on top of <a href="cons.html" title="cons"><tt class="computeroutput"><span class="identifier">cons</span></tt></a>. It is more efficient than
<a href="vector.html" title="vector"><tt class="computeroutput"><span class="identifier">vector</span></tt></a>
when the target sequence is constructed piecemeal (a data at a time). The
runtime cost of access to each element is peculiarly constant (see <a href="../../notes.html#fusion.notes.recursive_inlined_functions">Recursive Inlined Functions</a>).
</p>
<a name="fusion.sequences.containers.list.header"></a><h5>
<a name="id481420"></a>
<a href="list.html#fusion.sequences.containers.list.header">Header</a>
</h5>
<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">sequence</span><span class="special">/</span><span class="identifier">container</span><span class="special">/</span><span class="identifier">list</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">sequence</span><span class="special">/</span><span class="identifier">container</span><span class="special">/</span><span class="identifier">list</span><span class="special">/</span><span class="identifier">list_forward</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.sequences.containers.list.synopsis"></a><h5>
<a name="id481608"></a>
<a href="list.html#fusion.sequences.containers.list.synopsis">Synopsis</a>
</h5>
<pre class="programlisting">
<span class="keyword">template</span> <span class="special">&lt;</span>
<span class="keyword">typename</span> <span class="identifier">T0</span> <span class="special">=</span> <span class="emphasis"><em>unspecified</em></span>
<span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">T1</span> <span class="special">=</span> <span class="emphasis"><em>unspecified</em></span>
<span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">T2</span> <span class="special">=</span> <span class="emphasis"><em>unspecified</em></span>
<span class="special">...</span>
<span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">TN</span> <span class="special">=</span> <span class="emphasis"><em>unspecified</em></span>
<span class="special">&gt;</span>
<span class="keyword">struct</span> <span class="identifier">list</span><span class="special">;</span>
</pre>
<p>
The variadic class interface accepts <tt class="computeroutput"><span class="number">0</span></tt>
to <tt class="computeroutput"><span class="identifier">FUSION_MAX_LIST_SIZE</span></tt>
elements, where <tt class="computeroutput"><span class="identifier">FUSION_MAX_LIST_SIZE</span></tt>
is a user definable predefined maximum that defaults to <tt class="computeroutput"><span class="number">10</span></tt>.
Example:
</p>
<pre class="programlisting">
<span class="identifier">list</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">char</span><span class="special">,</span> <span class="keyword">double</span><span class="special">&gt;</span>
</pre>
<p>
You may define the preprocessor constant <tt class="computeroutput"><span class="identifier">FUSION_MAX_LIST_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_LIST_SIZE</span> <span class="number">20</span>
</pre>
<a name="fusion.sequences.containers.list.template_parameters"></a><h5>
<a name="id481928"></a>
<a href="list.html#fusion.sequences.containers.list.template_parameters">Template
parameters</a>
</h5>
<div class="informaltable">
<h4>
<a name="id481950"></a>
</h4>
<table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Parameter</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody><tr>
<td>
<tt class="computeroutput"><span class="identifier">T0</span></tt>...<tt class="computeroutput"><span class="identifier">TN</span></tt>
</td>
<td>Element types</td>
<td><span class="emphasis"><em>unspecified-type</em></span></td>
</tr></tbody>
</table>
</div>
<a name="fusion.sequences.containers.list.model_of"></a><h5>
<a name="id482023"></a>
<a href="list.html#fusion.sequences.containers.list.model_of">Model of</a>
</h5>
<div class="itemizedlist"><ul type="disc"><li><a href="../concepts/forward_sequence.html" title="Forward
Sequence">Forward Sequence</a></li></ul></div>
<div class="variablelist">
<p class="title"><b>Notation</b></p>
<dl>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">L</span></tt></span></dt>
<dd>
A <tt class="computeroutput"><span class="identifier">list</span></tt> type
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">l</span></tt></span></dt>
<dd>
An instance of <tt class="computeroutput"><span class="identifier">list</span></tt>
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">e0</span></tt>...<tt class="computeroutput"><span class="identifier">en</span></tt></span></dt>
<dd>
Heterogeneous values
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">s</span></tt></span></dt>
<dd>
A <a href="../concepts/forward_sequence.html" title="Forward
Sequence">Forward
Sequence</a>
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">N</span></tt></span></dt>
<dd>
An Integral Constant
</dd>
</dl>
</div>
<a name="fusion.sequences.containers.list.expression_semantics"></a><h5>
<a name="id482200"></a>
<a href="list.html#fusion.sequences.containers.list.expression_semantics">Expression
Semantics</a>
</h5>
<p>
Semantics of an expression is defined only where it differs from, or is
not defined in <a href="../concepts/forward_sequence.html" title="Forward
Sequence">Forward
Sequence</a>.
</p>
<div class="informaltable">
<h4>
<a name="id482238"></a>
</h4>
<table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>Expression</th>
<th>Semantics</th>
</tr></thead>
<tbody>
<tr>
<td><tt class="computeroutput"><span class="identifier">L</span><span class="special">()</span></tt></td>
<td>Creates
a list with default constructed elements.</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">L</span><span class="special">(</span><span class="identifier">e0</span><span class="special">,</span><EFBFBD><span class="identifier">e1</span><span class="special">,...</span><EFBFBD><span class="identifier">en</span><span class="special">)</span></tt></td>
<td>Creates
a list with elements <tt class="computeroutput"><span class="identifier">e0</span></tt>...<tt class="computeroutput"><span class="identifier">en</span></tt>.</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">L</span><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></tt></td>
<td>Copy
constructs a list from a <a href="../concepts/forward_sequence.html" title="Forward
Sequence">Forward
Sequence</a>, <tt class="computeroutput"><span class="identifier">s</span></tt>.</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">l</span><EFBFBD><span class="special">=</span><EFBFBD><span class="identifier">s</span></tt></td>
<td>Assigns to a list,
<tt class="computeroutput"><span class="identifier">l</span></tt>, from a <a href="../concepts/forward_sequence.html" title="Forward
Sequence">Forward
Sequence</a>, <tt class="computeroutput"><span class="identifier">s</span></tt>.</td>
</tr>
<tr>
<td><tt class="computeroutput"><a href="../intrinsics/functions/at.html" title="at"><tt class="computeroutput"><span class="identifier">at</span></tt></a><span class="special">&lt;</span><span class="identifier">N</span><span class="special">&gt;(</span><span class="identifier">l</span><span class="special">)</span></tt></td>
<td>The
Nth element from the beginning of the sequence; see <a href="../intrinsics/functions/at.html" title="at"><tt class="computeroutput"><span class="identifier">at</span></tt></a>.</td>
</tr>
</tbody>
</table>
</div>
<p class="blurb">
<span class="inlinemediaobject"><img src="../../../images/note.png" alt="note"></span><EFBFBD><tt class="computeroutput"><a href="../intrinsics/functions/at.html" title="at"><tt class="computeroutput"><span class="identifier">at</span></tt></a><span class="special">&lt;</span><span class="identifier">n</span><span class="special">&gt;(</span><span class="identifier">l</span><span class="special">)</span></tt> is
provided for convenience and compatibility with the original <a href="http://www.boost.org/libs/tuple/doc/tuple_users_guide.html" target="_top">Boost.Tuple</a>
library, despite <tt class="computeroutput"><span class="identifier">list</span></tt> being
a <a href="../concepts/forward_sequence.html" title="Forward
Sequence">Forward Sequence</a>
only (<a href="../intrinsics/functions/at.html" title="at"><tt class="computeroutput"><span class="identifier">at</span></tt></a> is supposed to be a <a href="../concepts/random_access_sequence.html" title="Random
Access Sequence">Random
Access Sequence</a> requirement). The runtime complexity of <a href="../intrinsics/functions/at.html" title="at"><tt class="computeroutput"><span class="identifier">at</span></tt></a> is constant (see <a href="../../notes.html#fusion.notes.recursive_inlined_functions">Recursive
Inlined Functions</a>).
</p>
<a name="fusion.sequences.containers.list.example"></a><h5>
<a name="id482703"></a>
<a href="list.html#fusion.sequences.containers.list.example">Example</a>
</h5>
<pre class="programlisting">
<span class="identifier">list</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">float</span><span class="special">&gt;</span> <span class="identifier">l</span><span class="special">(</span><span class="number">12</span><span class="special">,</span> <span class="number">5.5f</span><span class="special">);</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <a href="../intrinsics/functions/at.html" title="at"><tt class="computeroutput"><span class="identifier">at</span></tt></a><span class="special">&lt;</span><span class="number">0</span><span class="special">&gt;(</span><span class="identifier">l</span><span class="special">)</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <a href="../intrinsics/functions/at.html" title="at"><tt class="computeroutput"><span class="identifier">at</span></tt></a><span class="special">&lt;</span><span class="number">1</span><span class="special">&gt;(</span><span class="identifier">l</span><span class="special">)</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</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"><small>Copyright <20> 2001-2005 Joel de Guzman, Dan Marsden</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="cons.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../containers.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="set.html"><img src="../../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

225
doc/html/fusion/sequences/containers/map.html Normal file
View File

@ -0,0 +1,225 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>map</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<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="../containers.html" title="Containers">
<link rel="prev" href="set.html" title="set">
<link rel="next" href="../views.html" title="Views">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../../../libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="set.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../containers.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="../views.html"><img src="../../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="fusion.sequences.containers.map"></a><a href="map.html" title="map">map</a></h4></div></div></div>
<a name="fusion.sequences.containers.map.description"></a><h5>
<a name="id484465"></a>
<a href="map.html#fusion.sequences.containers.map.description">Description</a>
</h5>
<p>
map is an <a href="../concepts/associative_sequence.html" title="Associative
Sequence">Associative
Sequence</a> of heteregenous typed data elements. Each element is a
key/data pair (see <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>)
where the key has no data (type only). Type identity is used to impose
an equivalence relation on keys. A map may contain at most one element
for each key. Membership testing and element key lookup has constant runtime
complexity (see <a href="../../notes.html#fusion.notes.overloaded_functions">Overloaded
Functions</a>).
</p>
<a name="fusion.sequences.containers.map.header"></a><h5>
<a name="id484543"></a>
<a href="map.html#fusion.sequences.containers.map.header">Header</a>
</h5>
<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">sequence</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">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.sequences.containers.map.synopsis"></a><h5>
<a name="id484648"></a>
<a href="map.html#fusion.sequences.containers.map.synopsis">Synopsis</a>
</h5>
<pre class="programlisting">
<span class="keyword">template</span> <span class="special">&lt;</span>
<span class="keyword">typename</span> <span class="identifier">T0</span> <span class="special">=</span> <span class="emphasis"><em>unspecified</em></span>
<span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">T1</span> <span class="special">=</span> <span class="emphasis"><em>unspecified</em></span>
<span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">T2</span> <span class="special">=</span> <span class="emphasis"><em>unspecified</em></span>
<span class="special">...</span>
<span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">TN</span> <span class="special">=</span> <span class="emphasis"><em>unspecified</em></span>
<span class="special">&gt;</span>
<span class="keyword">struct</span> <span class="identifier">map</span><span class="special">;</span>
</pre>
<p>
The variadic class interface 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>.
Example:
</p>
<pre class="programlisting">
<span class="identifier">map</span><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="keyword">int</span><span class="special">,</span> <span class="keyword">char</span><span class="special">&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="keyword">char</span><span class="special">,</span> <span class="keyword">char</span><span class="special">&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="keyword">double</span><span class="special">,</span> <span class="keyword">char</span><span class="special">&gt;</span> <span class="special">&gt;</span>
</pre>
<p>
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.sequences.containers.map.template_parameters"></a><h5>
<a name="id485065"></a>
<a href="map.html#fusion.sequences.containers.map.template_parameters">Template
parameters</a>
</h5>
<div class="informaltable">
<h4>
<a name="id485087"></a>
</h4>
<table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Parameter</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody><tr>
<td>
<tt class="computeroutput"><span class="identifier">T0</span></tt>...<tt class="computeroutput"><span class="identifier">TN</span></tt>
</td>
<td>Element types</td>
<td><span class="emphasis"><em>unspecified-type</em></span></td>
</tr></tbody>
</table>
</div>
<a name="fusion.sequences.containers.map.model_of"></a><h5>
<a name="id485161"></a>
<a href="map.html#fusion.sequences.containers.map.model_of">Model of</a>
</h5>
<div class="itemizedlist"><ul type="disc">
<li><a href="../concepts/associative_sequence.html" title="Associative
Sequence">Associative
Sequence</a></li>
<li><a href="../concepts/forward_sequence.html" title="Forward
Sequence">Forward Sequence</a></li>
</ul></div>
<div class="variablelist">
<p class="title"><b>Notation</b></p>
<dl>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">M</span></tt></span></dt>
<dd>
A <tt class="computeroutput"><span class="identifier">map</span></tt> type
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">m</span></tt></span></dt>
<dd>
An instance of <tt class="computeroutput"><span class="identifier">map</span></tt>
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">e0</span></tt>...<tt class="computeroutput"><span class="identifier">en</span></tt></span></dt>
<dd>
Heterogeneous key/value pairs (see <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>)
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">s</span></tt></span></dt>
<dd>
A <a href="../concepts/forward_sequence.html" title="Forward
Sequence">Forward
Sequence</a>
</dd>
</dl>
</div>
<a name="fusion.sequences.containers.map.expression_semantics"></a><h5>
<a name="id485357"></a>
<a href="map.html#fusion.sequences.containers.map.expression_semantics">Expression
Semantics</a>
</h5>
<p>
Semantics of an expression is defined only where it differs from, or is
not defined in <a href="../concepts/random_access_sequence.html" title="Random
Access Sequence">Random
Access Sequence</a> and <a href="../concepts/associative_sequence.html" title="Associative
Sequence">Associative
Sequence</a>.
</p>
<div class="informaltable">
<h4>
<a name="id485405"></a>
</h4>
<table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>Expression</th>
<th>Semantics</th>
</tr></thead>
<tbody>
<tr>
<td><tt class="computeroutput"><span class="identifier">M</span><span class="special">()</span></tt></td>
<td>Creates
a map with default constructed elements.</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">M</span><span class="special">(</span><span class="identifier">e0</span><span class="special">,</span><EFBFBD><span class="identifier">e1</span><span class="special">,...</span><EFBFBD><span class="identifier">en</span><span class="special">)</span></tt></td>
<td>Creates
a map with element pairs <tt class="computeroutput"><span class="identifier">e0</span></tt>...<tt class="computeroutput"><span class="identifier">en</span></tt>.</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">M</span><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></tt></td>
<td>Copy
constructs a map from a <a href="../concepts/forward_sequence.html" title="Forward
Sequence">Forward
Sequence</a><EFBFBD><tt class="computeroutput"><span class="identifier">s</span></tt>.</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">m</span><EFBFBD><span class="special">=</span><EFBFBD><span class="identifier">s</span></tt></td>
<td>Assigns to a map,
<tt class="computeroutput"><span class="identifier">m</span></tt>, from a <a href="../concepts/forward_sequence.html" title="Forward
Sequence">Forward
Sequence</a><EFBFBD><tt class="computeroutput"><span class="identifier">s</span></tt>.</td>
</tr>
</tbody>
</table>
</div>
<a name="fusion.sequences.containers.map.example"></a><h5>
<a name="id485652"></a>
<a href="map.html#fusion.sequences.containers.map.example">Example</a>
</h5>
<pre class="programlisting">
<span class="keyword">typedef</span> <span class="identifier">map</span><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="keyword">int</span><span class="special">,</span> <span class="keyword">char</span><span class="special">&gt;</span>
<span class="special">,</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="keyword">double</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">&gt;</span> <span class="special">&gt;</span>
<span class="identifier">map_type</span><span class="special">;</span>
<span class="identifier">map_type</span> <span class="identifier">m</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">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>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <a href="../intrinsics/functions/at.html" title="at"><tt class="computeroutput"><span class="identifier">at</span></tt></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&gt;(</span><span class="identifier">m</span><span class="special">)</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <a href="../intrinsics/functions/at.html" title="at"><tt class="computeroutput"><span class="identifier">at</span></tt></a><span class="special">&lt;</span><span class="keyword">double</span><span class="special">&gt;(</span><span class="identifier">m</span><span class="special">)</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</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"><small>Copyright <20> 2001-2005 Joel de Guzman, Dan Marsden</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="set.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../containers.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="../views.html"><img src="../../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

217
doc/html/fusion/sequences/containers/set.html Normal file
View File

@ -0,0 +1,217 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>set</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<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="../containers.html" title="Containers">
<link rel="prev" href="list.html" title="list">
<link rel="next" href="map.html" title="map">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../../../libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="list.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../containers.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="map.html"><img src="../../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="fusion.sequences.containers.set"></a><a href="set.html" title="set">set</a></h4></div></div></div>
<a name="fusion.sequences.containers.set.description"></a><h5>
<a name="id482997"></a>
<a href="set.html#fusion.sequences.containers.set.description">Description</a>
</h5>
<p>
set is an <a href="../concepts/associative_sequence.html" title="Associative
Sequence">Associative
Sequence</a> of heteregenous typed data elements. Type identity is used
to impose an equivalence relation on keys. The element's type is its key.
A set may contain at most one element for each key. Membership testing
and element key lookup has constant runtime complexity (see <a href="../../notes.html#fusion.notes.overloaded_functions">Overloaded
Functions</a>).
</p>
<a name="fusion.sequences.containers.set.header"></a><h5>
<a name="id483051"></a>
<a href="set.html#fusion.sequences.containers.set.header">Header</a>
</h5>
<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">sequence</span><span class="special">/</span><span class="identifier">container</span><span class="special">/</span><span class="identifier">set</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.sequences.containers.set.synopsis"></a><h5>
<a name="id483156"></a>
<a href="set.html#fusion.sequences.containers.set.synopsis">Synopsis</a>
</h5>
<pre class="programlisting">
<span class="keyword">template</span> <span class="special">&lt;</span>
<span class="keyword">typename</span> <span class="identifier">T0</span> <span class="special">=</span> <span class="emphasis"><em>unspecified</em></span>
<span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">T1</span> <span class="special">=</span> <span class="emphasis"><em>unspecified</em></span>
<span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">T2</span> <span class="special">=</span> <span class="emphasis"><em>unspecified</em></span>
<span class="special">...</span>
<span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">TN</span> <span class="special">=</span> <span class="emphasis"><em>unspecified</em></span>
<span class="special">&gt;</span>
<span class="keyword">struct</span> <span class="identifier">set</span><span class="special">;</span>
</pre>
<p>
The variadic class interface accepts <tt class="computeroutput"><span class="number">0</span></tt>
to <tt class="computeroutput"><span class="identifier">FUSION_MAX_SET_SIZE</span></tt>
elements, where <tt class="computeroutput"><span class="identifier">FUSION_MAX_SET_SIZE</span></tt>
is a user definable predefined maximum that defaults to <tt class="computeroutput"><span class="number">10</span></tt>.
Example:
</p>
<pre class="programlisting">
<span class="identifier">set</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">char</span><span class="special">,</span> <span class="keyword">double</span><span class="special">&gt;</span>
</pre>
<p>
You may define the preprocessor constant <tt class="computeroutput"><span class="identifier">FUSION_MAX_SET_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_SET_SIZE</span> <span class="number">20</span>
</pre>
<a name="fusion.sequences.containers.set.template_parameters"></a><h5>
<a name="id483476"></a>
<a href="set.html#fusion.sequences.containers.set.template_parameters">Template
parameters</a>
</h5>
<div class="informaltable">
<h4>
<a name="id483498"></a>
</h4>
<table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Parameter</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody><tr>
<td>
<tt class="computeroutput"><span class="identifier">T0</span></tt>...<tt class="computeroutput"><span class="identifier">TN</span></tt>
</td>
<td>Element types</td>
<td><span class="emphasis"><em>unspecified-type</em></span></td>
</tr></tbody>
</table>
</div>
<a name="fusion.sequences.containers.set.model_of"></a><h5>
<a name="id483572"></a>
<a href="set.html#fusion.sequences.containers.set.model_of">Model of</a>
</h5>
<div class="itemizedlist"><ul type="disc">
<li><a href="../concepts/associative_sequence.html" title="Associative
Sequence">Associative
Sequence</a></li>
<li><a href="../concepts/forward_sequence.html" title="Forward
Sequence">Forward Sequence</a></li>
</ul></div>
<div class="variablelist">
<p class="title"><b>Notation</b></p>
<dl>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">S</span></tt></span></dt>
<dd>
A <tt class="computeroutput"><span class="identifier">set</span></tt> type
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">s</span></tt></span></dt>
<dd>
An instance of <tt class="computeroutput"><span class="identifier">set</span></tt>
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">e0</span></tt>...<tt class="computeroutput"><span class="identifier">en</span></tt></span></dt>
<dd>
Heterogeneous values
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">fs</span></tt></span></dt>
<dd>
A <a href="../concepts/forward_sequence.html" title="Forward
Sequence">Forward
Sequence</a>
</dd>
</dl>
</div>
<a name="fusion.sequences.containers.set.expression_semantics"></a><h5>
<a name="id483742"></a>
<a href="set.html#fusion.sequences.containers.set.expression_semantics">Expression
Semantics</a>
</h5>
<p>
Semantics of an expression is defined only where it differs from, or is
not defined in <a href="../concepts/random_access_sequence.html" title="Random
Access Sequence">Random
Access Sequence</a> and <a href="../concepts/associative_sequence.html" title="Associative
Sequence">Associative
Sequence</a>.
</p>
<div class="informaltable">
<h4>
<a name="id483790"></a>
</h4>
<table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>Expression</th>
<th>Semantics</th>
</tr></thead>
<tbody>
<tr>
<td><tt class="computeroutput"><span class="identifier">S</span><span class="special">()</span></tt></td>
<td>Creates
a set with default constructed elements.</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">S</span><span class="special">(</span><span class="identifier">e0</span><span class="special">,</span><EFBFBD><span class="identifier">e1</span><span class="special">,...</span><EFBFBD><span class="identifier">en</span><span class="special">)</span></tt></td>
<td>Creates
a set with elements <tt class="computeroutput"><span class="identifier">e0</span></tt>...<tt class="computeroutput"><span class="identifier">en</span></tt>.</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">S</span><span class="special">(</span><span class="identifier">fs</span><span class="special">)</span></tt></td>
<td>Copy
constructs a set from a <a href="../concepts/forward_sequence.html" title="Forward
Sequence">Forward
Sequence</a><EFBFBD><tt class="computeroutput"><span class="identifier">fs</span></tt>.</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">s</span><EFBFBD><span class="special">=</span><EFBFBD><span class="identifier">fs</span></tt></td>
<td>Assigns to a set,
<tt class="computeroutput"><span class="identifier">s</span></tt>, from a <a href="../concepts/forward_sequence.html" title="Forward
Sequence">Forward
Sequence</a><EFBFBD><tt class="computeroutput"><span class="identifier">fs</span></tt>.</td>
</tr>
</tbody>
</table>
</div>
<a name="fusion.sequences.containers.set.example"></a><h5>
<a name="id484038"></a>
<a href="set.html#fusion.sequences.containers.set.example">Example</a>
</h5>
<pre class="programlisting">
<span class="keyword">typedef</span> <span class="identifier">set</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">float</span><span class="special">&gt;</span> <span class="identifier">S</span><span class="special">;</span>
<span class="identifier">S</span> <span class="identifier">s</span><span class="special">(</span><span class="number">12</span><span class="special">,</span> <span class="number">5.5f</span><span class="special">);</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <a href="../intrinsics/functions/at_key.html" title="at_key"><tt class="computeroutput"><span class="identifier">at_key</span></tt></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&gt;(</span><span class="identifier">s</span><span class="special">)</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <a href="../intrinsics/functions/at_key.html" title="at_key"><tt class="computeroutput"><span class="identifier">at_key</span></tt></a><span class="special">&lt;</span><span class="keyword">float</span><span class="special">&gt;(</span><span class="identifier">s</span><span class="special">)</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <a href="../intrinsics/metafunctions/has_key.html" title="has_key"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">has_key</span></tt></a><span class="special">&lt;</span><span class="identifier">S</span><span class="special">,</span> <span class="keyword">double</span><span class="special">&gt;::</span><span class="identifier">value</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</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"><small>Copyright <20> 2001-2005 Joel de Guzman, Dan Marsden</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="list.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../containers.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="map.html"><img src="../../../images/next.png" alt="Next"></a>
</div>
</body>
</html>

247
doc/html/fusion/sequences/containers/vector.html Normal file
View File

@ -0,0 +1,247 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>vector</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<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="../containers.html" title="Containers">
<link rel="prev" href="../containers.html" title="Containers">
<link rel="next" href="cons.html" title="cons">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../../../libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../containers.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../containers.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="cons.html"><img src="../../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="fusion.sequences.containers.vector"></a><a href="vector.html" title="vector">vector</a></h4></div></div></div>
<a name="fusion.sequences.containers.vector.description"></a><h5>
<a name="id477500"></a>
<a href="vector.html#fusion.sequences.containers.vector.description">Description</a>
</h5>
<p>
<tt class="computeroutput"><span class="identifier">vector</span></tt> is a <a href="../concepts/random_access_sequence.html" title="Random
Access Sequence">Random
Access Sequence</a> of heterogenous typed data structured as a simple
<tt class="computeroutput"><span class="keyword">struct</span></tt> where each element
is held as a member variable. <tt class="computeroutput"><span class="identifier">vector</span></tt>
is the simplest of the Fusion sequence container, and in many cases the
most efficient.
</p>
<a name="fusion.sequences.containers.vector.header"></a><h5>
<a name="id477573"></a>
<a href="vector.html#fusion.sequences.containers.vector.header">Header</a>
</h5>
<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">sequence</span><span class="special">/</span><span class="identifier">container</span><span class="special">/</span><span class="identifier">vector</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">sequence</span><span class="special">/</span><span class="identifier">container</span><span class="special">/</span><span class="identifier">vector</span><span class="special">/</span><span class="identifier">vector_forward</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
<span class="comment">// numbered forms
</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">sequence</span><span class="special">/</span><span class="identifier">container</span><span class="special">/</span><span class="identifier">vector</span><span class="special">/</span><span class="identifier">vector10</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">sequence</span><span class="special">/</span><span class="identifier">container</span><span class="special">/</span><span class="identifier">vector</span><span class="special">/</span><span class="identifier">vector20</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">sequence</span><span class="special">/</span><span class="identifier">container</span><span class="special">/</span><span class="identifier">vector</span><span class="special">/</span><span class="identifier">vector30</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">sequence</span><span class="special">/</span><span class="identifier">container</span><span class="special">/</span><span class="identifier">vector</span><span class="special">/</span><span class="identifier">vector40</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">sequence</span><span class="special">/</span><span class="identifier">container</span><span class="special">/</span><span class="identifier">vector</span><span class="special">/</span><span class="identifier">vector50</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.sequences.containers.vector.synopsis"></a><h5>
<a name="id478181"></a>
<a href="vector.html#fusion.sequences.containers.vector.synopsis">Synopsis</a>
</h5>
<p>
<span class="bold"><b>Numbered forms</b></span>
</p>
<pre class="programlisting">
<span class="keyword">template</span> <span class="special">&lt;&gt;</span>
<span class="keyword">struct</span> <span class="identifier">vector0</span><span class="special">;</span>
<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">T0</span><span class="special">&gt;</span>
<span class="keyword">struct</span> <span class="identifier">vector1</span><span class="special">;</span>
<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">T0</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">T1</span><span class="special">&gt;</span>
<span class="keyword">struct</span> <span class="identifier">vector2</span><span class="special">;</span>
<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">T0</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">T1</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">T2</span><span class="special">&gt;</span>
<span class="keyword">struct</span> <span class="identifier">vector3</span><span class="special">;</span>
<span class="special">...</span>
<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">T0</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">T1</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">T2</span><span class="special">...,</span> <span class="keyword">typename</span> <span class="identifier">TN</span><span class="special">&gt;</span>
<span class="keyword">struct</span> <span class="identifier">vectorN</span><span class="special">;</span>
</pre>
<p>
<span class="bold"><b>Variadic form</b></span>
</p>
<pre class="programlisting">
<span class="keyword">template</span> <span class="special">&lt;</span>
<span class="keyword">typename</span> <span class="identifier">T0</span> <span class="special">=</span> <span class="emphasis"><em>unspecified</em></span>
<span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">T1</span> <span class="special">=</span> <span class="emphasis"><em>unspecified</em></span>
<span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">T2</span> <span class="special">=</span> <span class="emphasis"><em>unspecified</em></span>
<span class="special">...</span>
<span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">TN</span> <span class="special">=</span> <span class="emphasis"><em>unspecified</em></span>
<span class="special">&gt;</span>
<span class="keyword">struct</span> <span class="identifier">vector</span><span class="special">;</span>
</pre>
<p>
The numbered form accepts the exact number of elements. Example:
</p>
<pre class="programlisting">
<span class="identifier">vector3</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">char</span><span class="special">,</span> <span class="keyword">double</span><span class="special">&gt;</span>
</pre>
<p>
The variadic form accepts <tt class="computeroutput"><span class="number">0</span></tt>
to <tt class="computeroutput"><span class="identifier">FUSION_MAX_VECTOR_SIZE</span></tt>
elements, where <tt class="computeroutput"><span class="identifier">FUSION_MAX_VECTOR_SIZE</span></tt>
is a user definable predefined maximum that defaults to <tt class="computeroutput"><span class="number">10</span></tt>.
Example:
</p>
<pre class="programlisting">
<span class="identifier">vector</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">char</span><span class="special">,</span> <span class="keyword">double</span><span class="special">&gt;</span>
</pre>
<p>
You may define the preprocessor constant <tt class="computeroutput"><span class="identifier">FUSION_MAX_VECTOR_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_VECTOR_SIZE</span> <span class="number">20</span>
</pre>
<a name="fusion.sequences.containers.vector.template_parameters"></a><h5>
<a name="id478908"></a>
<a href="vector.html#fusion.sequences.containers.vector.template_parameters">Template
parameters</a>
</h5>
<div class="informaltable">
<h4>
<a name="id478930"></a>
</h4>
<table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Parameter</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody><tr>
<td>
<tt class="computeroutput"><span class="identifier">T0</span></tt>...<tt class="computeroutput"><span class="identifier">TN</span></tt>
</td>
<td>Element types</td>
<td><span class="emphasis"><em>unspecified</em></span></td>
</tr></tbody>
</table>
</div>
<a name="fusion.sequences.containers.vector.model_of"></a><h5>
<a name="id479003"></a>
<a href="vector.html#fusion.sequences.containers.vector.model_of">Model of</a>
</h5>
<div class="itemizedlist"><ul type="disc"><li><a href="../concepts/random_access_sequence.html" title="Random
Access Sequence">Random
Access Sequence</a></li></ul></div>
<div class="variablelist">
<p class="title"><b>Notation</b></p>
<dl>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">v</span></tt></span></dt>
<dd>
Instance of <tt class="computeroutput"><span class="identifier">vector</span></tt>
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">V</span></tt></span></dt>
<dd>
A <tt class="computeroutput"><span class="identifier">vector</span></tt> type
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">e0</span></tt>...<tt class="computeroutput"><span class="identifier">en</span></tt></span></dt>
<dd>
Heterogeneous values
</dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">s</span></tt></span></dt>
<dd>
A <a href="../concepts/forward_sequence.html" title="Forward
Sequence">Forward
Sequence</a>
</dd>
</dl>
</div>
<a name="fusion.sequences.containers.vector.expression_semantics"></a><h5>
<a name="id479162"></a>
<a href="vector.html#fusion.sequences.containers.vector.expression_semantics">Expression
Semantics</a>
</h5>
<p>
Semantics of an expression is defined only where it differs from, or is
not defined in <a href="../concepts/random_access_sequence.html" title="Random
Access Sequence">Random
Access Sequence</a>.
</p>
<div class="informaltable">
<h4>
<a name="id479200"></a>
</h4>
<table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>Expression</th>
<th>Semantics</th>
</tr></thead>
<tbody>
<tr>
<td><tt class="computeroutput"><span class="identifier">V</span><span class="special">()</span></tt></td>
<td>Creates
a vector with default constructed elements.</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">V</span><span class="special">(</span><span class="identifier">e0</span><span class="special">,</span><EFBFBD><span class="identifier">e1</span><span class="special">,...</span><EFBFBD><span class="identifier">en</span><span class="special">)</span></tt></td>
<td>Creates
a vector with elements <tt class="computeroutput"><span class="identifier">e0</span></tt>...<tt class="computeroutput"><span class="identifier">en</span></tt>.</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">V</span><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></tt></td>
<td>Copy
constructs a vector from a <a href="../concepts/forward_sequence.html" title="Forward
Sequence">Forward
Sequence</a>, <tt class="computeroutput"><span class="identifier">s</span></tt>.</td>
</tr>
<tr>
<td><tt class="computeroutput"><span class="identifier">v</span><EFBFBD><span class="special">=</span><EFBFBD><span class="identifier">s</span></tt></td>
<td>Assigns to a vector,
<tt class="computeroutput"><span class="identifier">v</span></tt>, from a <a href="../concepts/forward_sequence.html" title="Forward
Sequence">Forward
Sequence</a>, <tt class="computeroutput"><span class="identifier">s</span></tt>.</td>
</tr>
</tbody>
</table>
</div>
<a name="fusion.sequences.containers.vector.example"></a><h5>
<a name="id479448"></a>
<a href="vector.html#fusion.sequences.containers.vector.example">Example</a>
</h5>
<pre class="programlisting">
<span class="identifier">vector</span><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">float</span><span class="special">&gt;</span> <span class="identifier">v</span><span class="special">(</span><span class="number">12</span><span class="special">,</span> <span class="number">5.5f</span><span class="special">);</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <a href="../intrinsics/functions/at_c.html" title="at_c"><tt class="computeroutput"><span class="identifier">at_c</span></tt></a><span class="special">&lt;</span><span class="number">0</span><span class="special">&gt;(</span><span class="identifier">v</span><span class="special">)</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <a href="../intrinsics/functions/at_c.html" title="at_c"><tt class="computeroutput"><span class="identifier">at_c</span></tt></a><span class="special">&lt;</span><span class="number">1</span><span class="special">&gt;(</span><span class="identifier">v</span><span class="special">)</span> <span class="special">&lt;&lt;</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</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"><small>Copyright <20> 2001-2005 Joel de Guzman, Dan Marsden</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../containers.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../containers.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="cons.html"><img src="../../../images/next.png" alt="Next"></a>
</div>
</body>
</html>