summaryrefslogtreecommitdiff
path: root/libs/fusion/doc/html/fusion/sequence/intrinsic/functions/back.html
diff options
context:
space:
mode:
Diffstat (limited to 'libs/fusion/doc/html/fusion/sequence/intrinsic/functions/back.html')
-rwxr-xr-xlibs/fusion/doc/html/fusion/sequence/intrinsic/functions/back.html146
1 files changed, 146 insertions, 0 deletions
diff --git a/libs/fusion/doc/html/fusion/sequence/intrinsic/functions/back.html b/libs/fusion/doc/html/fusion/sequence/intrinsic/functions/back.html
new file mode 100755
index 0000000000..534058d181
--- /dev/null
+++ b/libs/fusion/doc/html/fusion/sequence/intrinsic/functions/back.html
@@ -0,0 +1,146 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>back</title>
+<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
+<link rel="home" href="../../../../index.html" title="Chapter&#160;1.&#160;Fusion 2.1">
+<link rel="up" href="../functions.html" title="Functions">
+<link rel="prev" href="front.html" title="front">
+<link rel="next" href="size.html" title="size">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
+<td align="center"><a href="../../../../../../../../index.html">Home</a></td>
+<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
+<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="front.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../functions.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="size.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="fusion.sequence.intrinsic.functions.back"></a><a class="link" href="back.html" title="back">back</a>
+</h5></div></div></div>
+<h6>
+<a name="fusion.sequence.intrinsic.functions.back.h0"></a>
+ <span><a name="fusion.sequence.intrinsic.functions.back.description"></a></span><a class="link" href="back.html#fusion.sequence.intrinsic.functions.back.description">Description</a>
+ </h6>
+<p>
+ Returns the last element in the sequence.
+ </p>
+<h6>
+<a name="fusion.sequence.intrinsic.functions.back.h1"></a>
+ <span><a name="fusion.sequence.intrinsic.functions.back.synopsis"></a></span><a class="link" href="back.html#fusion.sequence.intrinsic.functions.back.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 class="link" href="../metafunctions/back.html" title="back"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">back</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="identifier">back</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 class="link" href="../metafunctions/back.html" title="back"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">back</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="identifier">back</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>
+<h6>
+<a name="fusion.sequence.intrinsic.functions.back.h2"></a>
+ <span><a name="fusion.sequence.intrinsic.functions.back.parameters"></a></span><a class="link" href="back.html#fusion.sequence.intrinsic.functions.back.parameters">Parameters</a>
+ </h6>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Parameter
+ </p>
+ </th>
+<th>
+ <p>
+ Requirement
+ </p>
+ </th>
+<th>
+ <p>
+ Description
+ </p>
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <p>
+ <code class="computeroutput"><span class="identifier">seq</span></code>
+ </p>
+ </td>
+<td>
+ <p>
+ Model of <a class="link" href="../../concepts/bidirectional_sequence.html" title="Bidirectional Sequence">Bidirectional
+ Sequence</a>
+ </p>
+ </td>
+<td>
+ <p>
+ The sequence we wish to investigate.
+ </p>
+ </td>
+</tr></tbody>
+</table></div>
+<h6>
+<a name="fusion.sequence.intrinsic.functions.back.h3"></a>
+ <span><a name="fusion.sequence.intrinsic.functions.back.expression_semantics"></a></span><a class="link" href="back.html#fusion.sequence.intrinsic.functions.back.expression_semantics">Expression
+ Semantics</a>
+ </h6>
+<pre class="programlisting"><span class="identifier">back</span><span class="special">(</span><span class="identifier">seq</span><span class="special">);</span>
+</pre>
+<p>
+ <span class="bold"><strong>Return type</strong></span>: Returns a reference to
+ the last element in the sequence <code class="computeroutput"><span class="identifier">seq</span></code>
+ if <code class="computeroutput"><span class="identifier">seq</span></code> is mutable and
+ <code class="computeroutput"><span class="identifier">e</span> <span class="special">=</span>
+ <span class="identifier">o</span></code>, where <code class="computeroutput"><span class="identifier">e</span></code>
+ is the last element in the sequence, is a valid expression. Else, returns
+ a type convertable to the last element in the sequence.
+ </p>
+<p>
+ <span class="bold"><strong>Precondition</strong></span>: <code class="computeroutput"><a class="link" href="empty.html" title="empty"><code class="computeroutput"><span class="identifier">empty</span></code></a><span class="special">(</span><span class="identifier">seq</span><span class="special">)</span> <span class="special">==</span> <span class="keyword">false</span></code>
+ </p>
+<p>
+ <span class="bold"><strong>Semantics</strong></span>: Returns the last element
+ in the sequence.
+ </p>
+<h6>
+<a name="fusion.sequence.intrinsic.functions.back.h4"></a>
+ <span><a name="fusion.sequence.intrinsic.functions.back.header"></a></span><a class="link" href="back.html#fusion.sequence.intrinsic.functions.back.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">back</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">back</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
+</pre>
+<h6>
+<a name="fusion.sequence.intrinsic.functions.back.h5"></a>
+ <span><a name="fusion.sequence.intrinsic.functions.back.example"></a></span><a class="link" href="back.html#fusion.sequence.intrinsic.functions.back.example">Example</a>
+ </h6>
+<pre class="programlisting"><a class="link" 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><span class="identifier">back</span><span class="special">(</span><span class="identifier">v</span><span class="special">)</span> <span class="special">==</span> <span class="number">3</span><span class="special">);</span>
+</pre>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright &#169; 2001-2006, 2011 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="front.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../functions.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="size.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>