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

update for trac #1893

Browse Source 
[SVN r53856]
This commit is contained in:
Joel de Guzman
2009-06-13 06:29:32 +00:00
parent dace0940b7
commit 916077ce6b
254 changed files with 10143 additions and 12786 deletions
Download Patch File Download Diff File Expand all files Collapse all files

82
doc/html/fusion/sequence/intrinsic/functions/begin.html
View File

@ -3,10 +3,10 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>begin</title>
<link rel="stylesheet" href="../../../../../../../../doc/html/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="../../../../index.html" title="Chapter<65>1.<2E>Fusion 2.0">
<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">
<link rel="prev" href="../functions.html" title="Functions">
<link rel="previous" href="../functions.html" title="Functions">
<link rel="next" href="end.html" title="end">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@ -23,29 +23,33 @@
<a accesskey="p" href="../functions.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="end.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.sequence.intrinsic.functions.begin"></a><a href="begin.html" title="begin">begin</a></h5></div></div></div>
<div class="titlepage">
<div><div><h5 class="title">
<a name="fusion.sequence.intrinsic.functions.begin"></a><a href="begin.html" title="begin">begin</a>
</h5></div></div>
<div></div>
</div>
<a name="fusion.sequence.intrinsic.functions.begin.description"></a><h6>
<a name="id1006841"></a>
<a name="id449354"></a>
<a href="begin.html#fusion.sequence.intrinsic.functions.begin.description">Description</a>
</h6>
<p>
Returns an iterator pointing to the first element in the sequence.
</p>
<a name="fusion.sequence.intrinsic.functions.begin.synopsis"></a><h6>
<a name="id1006870"></a>
<a name="id449383"></a>
<a href="begin.html#fusion.sequence.intrinsic.functions.begin.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Sequence</span><span class="special">&gt;</span>
<span class="keyword">typename</span> <a href="../metafunctions/begin.html" title="begin"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">begin</span></code></a><span class="special">&lt;</span><span class="identifier">Sequence</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="keyword">typename</span> <a href="../metafunctions/begin.html" title="begin"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">begin</span></tt></a><span class="special">&lt;</span><span class="identifier">Sequence</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="identifier">begin</span><span class="special">(</span><span class="identifier">Sequence</span><span class="special">&amp;</span> <span class="identifier">seq</span><span class="special">);</span>
<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Sequence</span><span class="special">&gt;</span>
<span class="keyword">typename</span> <a href="../metafunctions/begin.html" title="begin"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">begin</span></code></a><span class="special">&lt;</span><span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="keyword">typename</span> <a href="../metafunctions/begin.html" title="begin"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">begin</span></tt></a><span class="special">&lt;</span><span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">&gt;::</span><span class="identifier">type</span>
<span class="identifier">begin</span><span class="special">(</span><span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">seq</span><span class="special">);</span>
</pre>
<a name="fusion.sequence.intrinsic.functions.begin.parameters"></a><h6>
<a name="id1007112"></a>
<a name="id449656"></a>
<a href="begin.html#fusion.sequence.intrinsic.functions.begin.parameters">Parameters</a>
</h6>
<div class="informaltable"><table class="table">
@ -55,84 +59,72 @@
<col>
</colgroup>
<thead><tr>
<th>
<p>
<th><p>
Parameter
</p>
</th>
<th>
<p>
</p></th>
<th><p>
Requirement
</p>
</th>
<th>
<p>
</p></th>
<th><p>
Description
</p>
</th>
</p></th>
</tr></thead>
<tbody><tr>
<td>
<p>
<code class="computeroutput"><span class="identifier">seq</span></code>
</p>
</td>
<td>
<p>
<td><p>
<tt class="computeroutput"><span class="identifier">seq</span></tt>
</p></td>
<td><p>
Model of <a href="../../concepts/forward_sequence.html" title="Forward
Sequence">Forward
Sequence</a>
</p>
</td>
<td>
<p>
</p></td>
<td><p>
The sequence we wish to get an iterator from.
</p>
</td>
</p></td>
</tr></tbody>
</table></div>
<a name="fusion.sequence.intrinsic.functions.begin.expression_semantics"></a><h6>
<a name="id1007216"></a>
<a name="id449770"></a>
<a href="begin.html#fusion.sequence.intrinsic.functions.begin.expression_semantics">Expression
Semantics</a>
</h6>
<pre class="programlisting"><span class="identifier">begin</span><span class="special">(</span><span class="identifier">seq</span><span class="special">);</span>
</pre>
<p>
<span class="bold"><strong>Return type</strong></span>: <a href="../../../iterator/concepts/forward_iterator.html" title="Forward
<span class="bold"><b>Return type</b></span>: <a href="../../../iterator/concepts/forward_iterator.html" title="Forward
Iterator">Forward
Iterator</a> if <code class="computeroutput"><span class="identifier">seq</span></code>
Iterator</a> if <tt class="computeroutput"><span class="identifier">seq</span></tt>
is a <a href="../../concepts/forward_sequence.html" title="Forward
Sequence">Forward
Sequence</a> else, <a href="../../../iterator/concepts/bidirectional_iterator.html" title="Bidirectional
Iterator">Bidirectional
Iterator</a> if <code class="computeroutput"><span class="identifier">seq</span></code>
Iterator</a> if <tt class="computeroutput"><span class="identifier">seq</span></tt>
is a <a href="../../concepts/bidirectional_sequence.html" title="Bidirectional
Sequence">Bidirectional
Sequence</a> else, <a href="../../../iterator/concepts/random_access_iterator.html" title="Random
Access Iterator">Random
Access Iterator</a> if <code class="computeroutput"><span class="identifier">seq</span></code>
Access Iterator</a> if <tt class="computeroutput"><span class="identifier">seq</span></tt>
is a <a href="../../concepts/random_access_sequence.html" title="Random
Access Sequence">Random
Access Sequence</a>.
</p>
<p>
<span class="bold"><strong>Semantics</strong></span>: Returns an iterator pointing
<span class="bold"><b>Semantics</b></span>: Returns an iterator pointing
to the first element in the sequence.
</p>
<a name="fusion.sequence.intrinsic.functions.begin.header"></a><h6>
<a name="id1007365"></a>
<a name="id449937"></a>
<a href="begin.html#fusion.sequence.intrinsic.functions.begin.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">sequence</span><span class="special">/</span><span class="identifier">intrinsic</span><span class="special">/</span><span class="identifier">begin</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">begin</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.sequence.intrinsic.functions.begin.example"></a><h6>
<a name="id1007514"></a>
<a name="id450104"></a>
<a href="begin.html#fusion.sequence.intrinsic.functions.begin.example">Example</a>
</h6>
<pre class="programlisting"><a href="../../../container/vector.html" title="vector"><code class="computeroutput"><span class="identifier">vector</span></code></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">v</span><span class="special">(</span><span class="number">1</span><span class="special">,</span> <span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">);</span>
<span class="identifier">assert</span><span class="special">(</span><a href="../../../iterator/functions/deref.html" title="deref"><code class="computeroutput"><span class="identifier">deref</span></code></a><span class="special">(</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">v</span><span class="special">))</span> <span class="special">==</span> <span class="number">1</span><span class="special">);</span>
<pre class="programlisting"><a href="../../../container/vector.html" title="vector"><tt class="computeroutput"><span class="identifier">vector</span></tt></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">v</span><span class="special">(</span><span class="number">1</span><span class="special">,</span> <span class="number">2</span><span class="special">,</span> <span class="number">3</span><span class="special">);</span>
<span class="identifier">assert</span><span class="special">(</span><a href="../../../iterator/functions/deref.html" title="deref"><tt class="computeroutput"><span class="identifier">deref</span></tt></a><span class="special">(</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">v</span><span class="special">))</span> <span class="special">==</span> <span class="number">1</span><span class="special">);</span>
</pre>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>