Files
boost_fusion/doc/html/fusion/sequence/intrinsic/metafunctions/begin.html
T

266 lines
13 KiB
HTML
Raw Normal View History

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>begin</title>
<link rel="stylesheet" href="../../../../../../../../doc/html/boostbook.css" type="text/css">
<<<<<<< .working
2009-10-11 16:12:54 +00:00
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
=======
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
<<<<<<< .working
>>>>>>> .merge-right.r57125
2009-09-14 07:47:53 +00:00
<link rel="home" href="../../../../index.html" title="Chapter 1. Fusion 2.0">
=======
<link rel="home" href="../../../../index.html" title="Chapter&#160;1.&#160;Fusion 2.0">
>>>>>>> .merge-right.r58299
<link rel="up" href="../metafunctions.html" title="Metafunctions">
2009-10-11 16:12:54 +00:00
<link rel="previous" href="../metafunctions.html" title="Metafunctions">
<link rel="next" href="end.html" title="end">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
2008-07-17 23:59:40 +00:00
<td align="center"><a href="../../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../libraries.htm">Libraries</a></td>
2008-07-17 23:59:40 +00:00
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../metafunctions.html"><img src="../../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../metafunctions.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>
2009-10-11 16:12:54 +00:00
<div class="section" lang="en">
<div class="titlepage">
<div><div><h5 class="title">
<a name="fusion.sequence.intrinsic.metafunctions.begin"></a><a href="begin.html" title="begin">begin</a>
</h5></div></div>
<div></div>
</div>
<a name="fusion.sequence.intrinsic.metafunctions.begin.description"></a><h6>
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
2009-10-11 16:12:54 +00:00
<a name="id460036"></a>
<a href="begin.html#fusion.sequence.intrinsic.metafunctions.begin.description">Description</a>
=======
<a name="id712512"></a>
=======
<a name="id672323"></a>
=======
<a name="id664677"></a>
=======
<a name="id684974"></a>
=======
<a name="id674745"></a>
=======
<a name="id671468"></a>
>>>>>>> .merge-right.r58559
>>>>>>> .merge-right.r58549
>>>>>>> .merge-right.r58299
>>>>>>> .merge-right.r57337
>>>>>>> .merge-right.r57242
<a class="link" href="begin.html#fusion.sequence.intrinsic.metafunctions.begin.description">Description</a>
>>>>>>> .merge-right.r57125
</h6>
<p>
2009-10-11 16:12:54 +00:00
Returns the result type of <a href="../functions/begin.html" title="begin"><tt class="computeroutput"><span class="identifier">begin</span></tt></a>.
</p>
<a name="fusion.sequence.intrinsic.metafunctions.begin.synopsis"></a><h6>
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
2009-10-11 16:12:54 +00:00
<a name="id460084"></a>
<a href="begin.html#fusion.sequence.intrinsic.metafunctions.begin.synopsis">Synopsis</a>
=======
<a name="id712540"></a>
=======
<a name="id672352"></a>
=======
<a name="id664706"></a>
=======
<a name="id685003"></a>
=======
<a name="id674774"></a>
=======
<a name="id671497"></a>
>>>>>>> .merge-right.r58559
>>>>>>> .merge-right.r58549
>>>>>>> .merge-right.r58299
>>>>>>> .merge-right.r57337
>>>>>>> .merge-right.r57242
<a class="link" href="begin.html#fusion.sequence.intrinsic.metafunctions.begin.synopsis">Synopsis</a>
>>>>>>> .merge-right.r57125
</h6>
2009-09-14 07:47:53 +00:00
<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Seq</span><span class="special">&gt;</span>
<span class="keyword">struct</span> <span class="identifier">begin</span>
<span class="special">{</span>
<span class="keyword">typedef</span> <span class="emphasis"><em>unspecified</em></span> <span class="identifier">type</span><span class="special">;</span>
<span class="special">};</span>
</pre>
<div class="table">
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
2009-10-11 16:12:54 +00:00
<a name="id460180"></a><p class="title"><b>Table 1.19. Parameters</b></p>
<table class="table" summary="Parameters">
=======
<a name="id712610"></a><p class="title"><b>Table 1.19. Parameters</b></p>
=======
<a name="id672422"></a><p class="title"><b>Table 1.23. Parameters</b></p>
=======
<a name="id664776"></a><p class="title"><b>Table 1.23. Parameters</b></p>
=======
<a name="id685072"></a><p class="title"><b>Table&#160;1.23.&#160;Parameters</b></p>
=======
<a name="id674843"></a><p class="title"><b>Table&#160;1.23.&#160;Parameters</b></p>
=======
<a name="id671566"></a><p class="title"><b>Table&#160;1.23.&#160;Parameters</b></p>
>>>>>>> .merge-right.r58559
>>>>>>> .merge-right.r58549
>>>>>>> .merge-right.r58299
>>>>>>> .merge-right.r57337
>>>>>>> .merge-right.r57242
<div class="table-contents"><table class="table" summary="Parameters">
>>>>>>> .merge-right.r57125
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
2009-10-11 16:12:54 +00:00
<th><p>
Parameter
2009-10-11 16:12:54 +00:00
</p></th>
<th><p>
Requirement
2009-10-11 16:12:54 +00:00
</p></th>
<th><p>
Description
2009-10-11 16:12:54 +00:00
</p></th>
</tr></thead>
<tbody><tr>
2009-10-11 16:12:54 +00:00
<td><p>
<tt class="computeroutput"><span class="identifier">Seq</span></tt>
</p></td>
<td><p>
A model of <a href="../../concepts/forward_sequence.html" title="Forward
Sequence">Forward
Sequence</a>
2009-10-11 16:12:54 +00:00
</p></td>
<td><p>
Argument sequence
2009-10-11 16:12:54 +00:00
</p></td>
</tr></tbody>
2009-10-11 16:12:54 +00:00
</table>
</div>
<<<<<<< .working
2009-10-11 16:12:54 +00:00
<a name="fusion.sequence.intrinsic.metafunctions.begin.expression_semantics"></a><h6>
<a name="id460281"></a>
<a href="begin.html#fusion.sequence.intrinsic.metafunctions.begin.expression_semantics">Expression
=======
<br class="table-break"><a name="fusion.sequence.intrinsic.metafunctions.begin.expression_semantics"></a><h6>
<a name="id671648"></a>
<a class="link" href="begin.html#fusion.sequence.intrinsic.metafunctions.begin.expression_semantics">Expression
>>>>>>> .merge-right.r57125
Semantics</a>
</h6>
2009-09-14 07:47:53 +00:00
<pre class="programlisting"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">begin</span><span class="special">&lt;</span><span class="identifier">Seq</span><span class="special">&gt;::</span><span class="identifier">type</span>
</pre>
<p>
<<<<<<< .working
2009-10-11 16:12:54 +00:00
<span class="bold"><b>Return type</b></span>: An iterator modelling the
same traversal concept as <tt class="computeroutput"><span class="identifier">Seq</span></tt>.
=======
<span class="bold"><strong>Return type</strong></span>:
>>>>>>> .merge-right.r57242
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
A model of <a class="link" href="../../../iterator/concepts/forward_iterator.html" title="Forward Iterator">Forward
Iterator</a> if <code class="computeroutput"><span class="identifier">seq</span></code>
is a <a class="link" href="../../concepts/forward_sequence.html" title="Forward Sequence">Forward
Sequence</a> else, <a class="link" href="../../../iterator/concepts/bidirectional_iterator.html" title="Bidirectional Iterator">Bidirectional
Iterator</a> if <code class="computeroutput"><span class="identifier">seq</span></code>
is a <a class="link" href="../../concepts/bidirectional_sequence.html" title="Bidirectional Sequence">Bidirectional
Sequence</a> else, <a class="link" 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>
is a <a class="link" href="../../concepts/random_access_sequence.html" title="Random Access Sequence">Random
Access Sequence</a>.
</li>
<li class="listitem">
A model of <a class="link" href="../../../iterator/concepts/associative_iterator.html" title="Associative Iterator">Associative
Iterator</a> if <code class="computeroutput"><span class="identifier">seq</span></code>
is an <a class="link" href="../../concepts/associative_sequence.html" title="Associative Sequence">Associative
Sequence</a>.
</li>
</ul></div>
<p>
2009-10-11 16:12:54 +00:00
<span class="bold"><b>Semantics</b></span>: Returns the type of an iterator
to the first element of <tt class="computeroutput"><span class="identifier">Seq</span></tt>.
</p>
<a name="fusion.sequence.intrinsic.metafunctions.begin.header"></a><h6>
<a name="id671793"></a>
<a class="link" href="begin.html#fusion.sequence.intrinsic.metafunctions.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.metafunctions.begin.example"></a><h6>
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
<<<<<<< .working
2009-10-11 16:12:54 +00:00
<a name="id460401"></a>
<a href="begin.html#fusion.sequence.intrinsic.metafunctions.begin.example">Example</a>
=======
<a name="id712770"></a>
=======
<a name="id672764"></a>
=======
<a name="id665118"></a>
=======
<a name="id685414"></a>
=======
<a name="id675185"></a>
=======
<a name="id671908"></a>
>>>>>>> .merge-right.r58559
>>>>>>> .merge-right.r58549
>>>>>>> .merge-right.r58299
>>>>>>> .merge-right.r57337
>>>>>>> .merge-right.r57242
<a class="link" href="begin.html#fusion.sequence.intrinsic.metafunctions.begin.example">Example</a>
>>>>>>> .merge-right.r57125
</h6>
2009-10-11 16:12:54 +00:00
<pre class="programlisting"><span class="keyword">typedef</span> <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">&gt;</span> <span class="identifier">vec</span><span class="special">;</span>
<span class="keyword">typedef</span> <a href="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">vec</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">it</span><span class="special">;</span>
<span class="identifier">BOOST_MPL_ASSERT</span><span class="special">((</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">is_same</span><span class="special">&lt;</span><a href="../../../iterator/metafunctions/deref.html" title="deref"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">deref</span></tt></a><span class="special">&lt;</span><span class="identifier">it</span><span class="special">&gt;::</span><span class="identifier">type</span><span class="special">,</span> <span class="keyword">int</span><span class="special">&amp;&gt;))</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 &#169; 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="../metafunctions.html"><img src="../../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../metafunctions.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>
</body>
</html>