Added libs/mpl

[SVN r15384]

doc/ref/Reference/begin.html

@@ -0,0 +1,56 @@
+<!doctype html public "-//ietf//dtd html//en">
+<html><head><title>boost::mpl::Reference/begin</title>
+<link rel="stylesheet" href="../mpl_wiki.css">
+</head><body bgcolor="white">
+<h1><a href="../Table_of_Content.html"><img src="../mpl_logo.jpg" alt="[Home]" border=0 align="right"></a>begin</h1><h3>Synopsis</h3>
+<p>
+<pre>
+template&lt;
+      typename Sequence
+    &gt;
+struct begin
+{
+    typedef <em>unspecified</em> type;
+};
+</pre>
+<p>
+<h3>Description</h3>
+<p>
+Returns an iterator that points to the first element of the sequence.
+<p>
+<h3>Definition</h3>
+<p>
+<pre>
+#include "<a href="../../../../../\boost/mpl/begin_end.hpp">boost/mpl/begin_end.hpp</a>"
+</pre>
+<p>
+<h3>Parameters</h3>
+<table border="1">
+<tr><th>&nbsp;Parameter&nbsp;</th><th>&nbsp;Requirement&nbsp;</th><th>&nbsp;Description &nbsp;</th></tr>
+<tr><td><code>Sequence</code></td><td>A model of <a href="../Sequence.html">Sequence</a></td><td></td></tr>
+</table>
+<p>
+<h3>Expression semantics</h3>
+<p>
+<table border="1">
+<tr><th>&nbsp;Expression&nbsp;</th><th>&nbsp;Expression&nbsp;type&nbsp;</th><th>&nbsp;Precondition&nbsp;</th><th>&nbsp;Semantics&nbsp;</th><th>&nbsp;Postcondition&nbsp;</th></tr>
+<tr><td><code>typedef begin&lt;Sequence&gt;::type first;</code></td><td>A model of <a href="../Input_Iterator.html">Input Iterator</a></td><td></td><td><code>first</code> is an iterator pointing to the first element of the <code>Sequence</code>; equivalent to <code>Sequence::begin</code> unless the algorithm has been specialized for the particular type of sequence.</td><td><code>first</code> is either dereferenceable or past-the-end; it is past-the-end if and only if <code>size&lt;Sequence&gt;::type::value == 0</code>. </td></tr>
+</table>
+<p>
+<h3>Complexity</h3>
+<p>
+Amortized constant time.
+<p>
+<h3>Example</h3>
+<p>
+<pre>
+typedef vector&lt;unsigned char,unsigned short,unsigned int, unsigned long&gt; unsigned_types;
+typedef begin&lt;unsigned_types&gt;::type iter;
+BOOST_STATIC_ASSERT((boost::is_same&lt;iter::type,unsigned char&gt;::value));
+</pre>
+<p>
+<h3>See also</h3>
+<p>
+<a href="../Iterators.html">Iterators</a>, <a href="../Sequence.html">Sequence</a>, <code><a href="../Reference/end.html">end</a></code>, <code><a href="../Reference/size.html">size</a></code>, <code><a href="../Reference/empty.html">empty</a></code>
+<p><hr>
+<a href="../Table_of_Content.html">Table of Content</a> | <a href="../Reference.html">Reference</a><br>Last edited July 22, 2002 2:03 am</body></html>