diff options
author | Anas Nashif <anas.nashif@intel.com> | 2012-10-30 12:57:26 -0700 |
---|---|---|
committer | Anas Nashif <anas.nashif@intel.com> | 2012-10-30 12:57:26 -0700 |
commit | 1a78a62555be32868418fe52f8e330c9d0f95d5a (patch) | |
tree | d3765a80e7d3b9640ec2e930743630cd6b9fce2b /doc/html/boost/signals2/optional_last_value.html | |
download | boost-1a78a62555be32868418fe52f8e330c9d0f95d5a.tar.gz boost-1a78a62555be32868418fe52f8e330c9d0f95d5a.tar.bz2 boost-1a78a62555be32868418fe52f8e330c9d0f95d5a.zip |
Imported Upstream version 1.49.0upstream/1.49.0
Diffstat (limited to 'doc/html/boost/signals2/optional_last_value.html')
-rwxr-xr-x | doc/html/boost/signals2/optional_last_value.html | 103 |
1 files changed, 103 insertions, 0 deletions
diff --git a/doc/html/boost/signals2/optional_last_value.html b/doc/html/boost/signals2/optional_last_value.html new file mode 100755 index 0000000000..8d69d251cb --- /dev/null +++ b/doc/html/boost/signals2/optional_last_value.html @@ -0,0 +1,103 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Class template optional_last_value</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="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../signals2/reference.html#header.boost.signals2.optional_last_value_hpp" title="Header <boost/signals2/optional_last_value.hpp>"> +<link rel="prev" href="mutex.html" title="Class mutex"> +<link rel="next" href="optional_last_value_voi_id1379848.html" title="Class optional_last_value<void>"> +</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="mutex.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../signals2/reference.html#header.boost.signals2.optional_last_value_hpp"><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="optional_last_value_voi_id1379848.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.signals2.optional_last_value"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class template optional_last_value</span></h2> +<p>boost::signals2::optional_last_value — Evaluate an <a class="link" href="../../InputIterator.html" title="Concept InputIterator">InputIterator</a> sequence and return + a boost::optional which contains the last value in the sequence, or an + empty boost::optional if the sequence was empty.</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../signals2/reference.html#header.boost.signals2.optional_last_value_hpp" title="Header <boost/signals2/optional_last_value.hpp>">boost/signals2/optional_last_value.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> +<span class="keyword">class</span> <a class="link" href="optional_last_value.html" title="Class template optional_last_value">optional_last_value</a> <span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> boost::optional<span class="special"><</span><span class="identifier">T</span><span class="special">></span> <a name="boost.signals2.optional_last_value.result_type"></a><span class="identifier">result_type</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="optional_last_value.html#id1401350-bb">invocation</a></span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <a class="link" href="../../InputIterator.html" title="Concept InputIterator">InputIterator</a><span class="special">></span> + <span class="identifier">result_type</span> <a class="link" href="optional_last_value.html#id807202-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">InputIterator</span><span class="special">,</span> <span class="identifier">InputIterator</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id3161549"></a><h2>Description</h2> +<p> + <code class="computeroutput">optional_last_value</code> is the default Combiner template type for signals in the + Boost.Signals2 library. The advantage of <code class="computeroutput">optional_last_value</code> over + <a class="link" href="last_value.html" title="Class template last_value">signals2::last_value</a> is that <code class="computeroutput">optional_last_value</code> + can return an empty boost::optional. rather + than throwing an exception, when + its <code class="computeroutput">InputIterator</code> sequence is empty. + </p> +<div class="refsect2"> +<a name="id3161593"></a><h3> +<a name="id1401350-bb"></a><code class="computeroutput">optional_last_value</code> invocation</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <a class="link" href="../../InputIterator.html" title="Concept InputIterator">InputIterator</a><span class="special">></span> + <span class="identifier">result_type</span> <a name="id807202-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">InputIterator</span> first<span class="special">,</span> <span class="identifier">InputIterator</span> last<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Effects:</span></p></td> +<td><p>Attempts to dereference every iterator in the sequence <code class="computeroutput">[first, last)</code>. + </p></td> +</tr> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td><p> + The result of the last successful iterator dereference, wrapped in a boost::optional. + The returned <code class="computeroutput">optional</code> will be empty if no iterators were dereferenced. + </p></td> +</tr> +<tr> +<td><p><span class="term">Throws:</span></p></td> +<td><p>Does not throw.</p></td> +</tr> +</tbody> +</table></div> +</li></ol></div> +</div> +<div class="refsect2"> +<a name="id3161747"></a><h3>Specializations</h3> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><a class="link" href="optional_last_value_voi_id1379848.html" title="Class optional_last_value<void>">Class optional_last_value<void></a></p></li></ul></div> +</div> +</div> +</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 © 2001-2004 Douglas Gregor<br>Copyright © 2007-2009 Frank Mori Hess<p>Distributed under the Boost + Software License, Version 1.0. (See accompanying file + <code class="filename">LICENSE_1_0.txt</code> 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="mutex.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../signals2/reference.html#header.boost.signals2.optional_last_value_hpp"><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="optional_last_value_voi_id1379848.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |