boost-react-native-bundle
Version:
Boost library as in https://sourceforge.net/projects/boost/files/boost/1.57.0/
418 lines (391 loc) • 301 kB
HTML
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>TR1 By Subject</title>
<link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<link rel="up" href="../boost_tr1.html" title="Chapter 31. Boost.TR1">
<link rel="prev" href="config.html" title="Configuration">
<link rel="next" href="header_list.html" title="TR1 By Header">
</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="config.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost_tr1.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="header_list.html"><img src="../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="boost_tr1.subject_list"></a><a class="link" href="subject_list.html" title="TR1 By Subject">TR1 By Subject</a>
</h2></div></div></div>
<div class="toc"><dl class="toc">
<dt><span class="section"><a href="subject_list.html#boost_tr1.subject_list.ref">Reference Wrappers.</a></span></dt>
<dt><span class="section"><a href="subject_list.html#boost_tr1.subject_list.ptrs">Smart Pointers.</a></span></dt>
<dt><span class="section"><a href="subject_list.html#boost_tr1.subject_list.result_of">Class template result_of.</a></span></dt>
<dt><span class="section"><a href="subject_list.html#boost_tr1.subject_list.mem_fn">Function template mem_fn.</a></span></dt>
<dt><span class="section"><a href="subject_list.html#boost_tr1.subject_list.bind">Function Object Binders.</a></span></dt>
<dt><span class="section"><a href="subject_list.html#boost_tr1.subject_list.function">Polymorphic function
wrappers.</a></span></dt>
<dt><span class="section"><a href="subject_list.html#boost_tr1.subject_list.type_traits">Type Traits.</a></span></dt>
<dt><span class="section"><a href="subject_list.html#boost_tr1.subject_list.random">Random Number Generators
and Distributions.</a></span></dt>
<dt><span class="section"><a href="subject_list.html#boost_tr1.subject_list.tuple">Tuples.</a></span></dt>
<dt><span class="section"><a href="subject_list.html#boost_tr1.subject_list.utility">Tuple Interface to std::pair.</a></span></dt>
<dt><span class="section"><a href="subject_list.html#boost_tr1.subject_list.array">Fixed Size Array.</a></span></dt>
<dt><span class="section"><a href="subject_list.html#boost_tr1.subject_list.hash">Hash Function Objects.</a></span></dt>
<dt><span class="section"><a href="subject_list.html#boost_tr1.subject_list.regex">Regular Expressions.</a></span></dt>
<dt><span class="section"><a href="subject_list.html#boost_tr1.subject_list.complex">Complex Number Algorithm
Overloads.</a></span></dt>
<dt><span class="section"><a href="subject_list.html#boost_tr1.subject_list.complex_trig">Complex Number Additional
Algorithms.</a></span></dt>
<dt><span class="section"><a href="subject_list.html#boost_tr1.subject_list.unordered_set">Unordered Associative
Set (Hash Table).</a></span></dt>
<dt><span class="section"><a href="subject_list.html#boost_tr1.subject_list.unordered_map">Unordered Associative
Map (Hash Table).</a></span></dt>
<dt><span class="section"><a href="subject_list.html#boost_tr1.subject_list.special">Mathematical Special
Functions.</a></span></dt>
<dt><span class="section"><a href="subject_list.html#boost_tr1.subject_list.c99_special">C99 Mathematical
Special Functions.</a></span></dt>
</dl></div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_tr1.subject_list.ref"></a><a class="link" href="subject_list.html#boost_tr1.subject_list.ref" title="Reference Wrappers.">Reference Wrappers.</a>
</h3></div></div></div>
<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">tr1</span><span class="special">/</span><span class="identifier">functional</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
</pre>
<p>
or
</p>
<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">functional</span><span class="special">></span>
</pre>
<p>
The Ref library is a small library that is useful for passing references
to function templates (algorithms) that would usually take copies of their
arguments. It defines the class template <code class="computeroutput"><span class="identifier">reference_wrapper</span><span class="special"><</span><span class="identifier">T</span><span class="special">></span></code>,
and the two functions <code class="computeroutput"><span class="identifier">ref</span></code>
and <code class="computeroutput"><span class="identifier">cref</span></code> that return instances
of <code class="computeroutput"><span class="identifier">reference_wrapper</span><span class="special"><</span><span class="identifier">T</span><span class="special">></span></code>.
<a href="../../../doc/html/ref.html" target="_top">Refer to Boost.Bind for more information.</a>
</p>
<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">std</span> <span class="special">{</span>
<span class="keyword">namespace</span> <span class="identifier">tr1</span> <span class="special">{</span>
<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">></span> <span class="keyword">class</span> <span class="identifier">reference_wrapper</span><span class="special">;</span>
<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">></span> <span class="identifier">reference_wrapper</span><span class="special"><</span><span class="identifier">T</span><span class="special">></span> <span class="identifier">ref</span><span class="special">(</span><span class="identifier">T</span><span class="special">&);</span>
<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">></span> <span class="identifier">reference_wrapper</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">></span> <span class="identifier">cref</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">&);</span>
<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">></span> <span class="identifier">reference_wrapper</span><span class="special"><</span><span class="identifier">T</span><span class="special">></span> <span class="identifier">ref</span><span class="special">(</span><span class="identifier">reference_wrapper</span><span class="special"><</span><span class="identifier">T</span><span class="special">>);</span>
<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">></span> <span class="identifier">reference_wrapper</span><span class="special"><</span><span class="keyword">const</span> <span class="identifier">T</span><span class="special">></span> <span class="identifier">cref</span><span class="special">(</span><span class="identifier">reference_wrapper</span><span class="special"><</span><span class="identifier">T</span><span class="special">>);</span>
<span class="special">}</span> <span class="comment">// namespace tr1</span>
<span class="special">}</span> <span class="comment">// namespace std</span>
</pre>
<p>
<span class="bold"><strong>Configuration:</strong></span> <a href="../../../libs/config/index.html" target="_top">Boost.Config</a>
should (automatically) define the macro BOOST_HAS_TR1_REFERENCE_WRAPPER if
your standard library implements this part of TR1.
</p>
<p>
<span class="bold"><strong>Standard Conformity:</strong></span> The Boost version of
this this component does not currently support function call invocation (2.1.2.4),
or derivation from std::unary_function or std::binary_function (2.1.2 paragraphs
3 and 4).
</p>
<p>
The Boost version is not implicitly convertible to T& as the TR requires.
</p>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_tr1.subject_list.ptrs"></a><a class="link" href="subject_list.html#boost_tr1.subject_list.ptrs" title="Smart Pointers.">Smart Pointers.</a>
</h3></div></div></div>
<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">tr1</span><span class="special">/</span><span class="identifier">memory</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
</pre>
<p>
or
</p>
<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">memory</span><span class="special">></span>
</pre>
<p>
The <code class="computeroutput"><span class="identifier">shared_ptr</span></code> class template
stores a pointer to a dynamically allocated object, typically with a C++
new-expression. The object pointed to is guaranteed to be deleted when the
last <code class="computeroutput"><span class="identifier">shared_ptr</span></code> pointing
to it is destroyed or reset. For more information refer to the <a href="../../../libs/smart_ptr/shared_ptr.htm" target="_top">shared_ptr</a>
and <a href="../../../libs/smart_ptr/weak_ptr.htm" target="_top">weak_ptr</a> documentation.
</p>
<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">std</span> <span class="special">{</span>
<span class="keyword">namespace</span> <span class="identifier">tr1</span> <span class="special">{</span>
<span class="keyword">class</span> <span class="identifier">bad_weak_ptr</span><span class="special">;</span>
<span class="comment">// [2.2.3] Class template shared_ptr</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">></span> <span class="keyword">class</span> <span class="identifier">shared_ptr</span><span class="special">;</span>
<span class="comment">// [2.2.3.6] shared_ptr comparisons</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">U</span><span class="special">></span> <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">==(</span><span class="identifier">shared_ptr</span><span class="special"><</span><span class="identifier">T</span><span class="special">></span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">a</span><span class="special">,</span> <span class="identifier">shared_ptr</span><span class="special"><</span><span class="identifier">U</span><span class="special">></span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">b</span><span class="special">);</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">U</span><span class="special">></span> <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">!=(</span><span class="identifier">shared_ptr</span><span class="special"><</span><span class="identifier">T</span><span class="special">></span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">a</span><span class="special">,</span> <span class="identifier">shared_ptr</span><span class="special"><</span><span class="identifier">U</span><span class="special">></span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">b</span><span class="special">);</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">U</span><span class="special">></span> <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special"><(</span><span class="identifier">shared_ptr</span><span class="special"><</span><span class="identifier">T</span><span class="special">></span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">a</span><span class="special">,</span> <span class="identifier">shared_ptr</span><span class="special"><</span><span class="identifier">U</span><span class="special">></span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">b</span><span class="special">);</span>
<span class="comment">// [2.2.3.8] shared_ptr specialized algorithms</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">></span> <span class="keyword">void</span> <span class="identifier">swap</span><span class="special">(</span><span class="identifier">shared_ptr</span><span class="special"><</span><span class="identifier">T</span><span class="special">>&</span> <span class="identifier">a</span><span class="special">,</span> <span class="identifier">shared_ptr</span><span class="special"><</span><span class="identifier">T</span><span class="special">>&</span> <span class="identifier">b</span><span class="special">);</span>
<span class="comment">// [2.2.3.9] shared_ptr casts</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">U</span><span class="special">></span> <span class="identifier">shared_ptr</span><span class="special"><</span><span class="identifier">T</span><span class="special">></span> <span class="identifier">static_pointer_cast</span><span class="special">(</span><span class="identifier">shared_ptr</span><span class="special"><</span><span class="identifier">U</span><span class="special">></span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">r</span><span class="special">);</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">U</span><span class="special">></span> <span class="identifier">shared_ptr</span><span class="special"><</span><span class="identifier">T</span><span class="special">></span> <span class="identifier">dynamic_pointer_cast</span><span class="special">(</span><span class="identifier">shared_ptr</span><span class="special"><</span><span class="identifier">U</span><span class="special">></span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">r</span><span class="special">);</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">U</span><span class="special">></span> <span class="identifier">shared_ptr</span><span class="special"><</span><span class="identifier">T</span><span class="special">></span> <span class="identifier">const_pointer_cast</span><span class="special">(</span><span class="identifier">shared_ptr</span><span class="special"><</span><span class="identifier">U</span><span class="special">></span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">r</span><span class="special">);</span>
<span class="comment">// [2.2.3.7] shared_ptr I/O</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">E</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Y</span><span class="special">></span>
<span class="identifier">basic_ostream</span><span class="special"><</span><span class="identifier">E</span><span class="special">,</span> <span class="identifier">T</span><span class="special">>&</span> <span class="keyword">operator</span><span class="special"><<</span> <span class="special">(</span><span class="identifier">basic_ostream</span><span class="special"><</span><span class="identifier">E</span><span class="special">,</span> <span class="identifier">T</span><span class="special">>&</span> <span class="identifier">os</span><span class="special">,</span> <span class="identifier">shared_ptr</span><span class="special"><</span><span class="identifier">Y</span><span class="special">></span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">p</span><span class="special">);</span>
<span class="comment">// [2.2.3.10] shared_ptr get_deleter</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">D</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T</span><span class="special">></span> <span class="identifier">D</span> <span class="special">*</span> <span class="identifier">get_deleter</span><span class="special">(</span><span class="identifier">shared_ptr</span><span class="special"><</span><span class="identifier">T</span><span class="special">></span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">p</span><span class="special">);</span>
<span class="comment">// [2.2.4] Class template weak_ptr</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">></span> <span class="keyword">class</span> <span class="identifier">weak_ptr</span><span class="special">;</span>
<span class="comment">// [2.2.4.6] weak_ptr comparison</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">U</span><span class="special">></span> <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special"><(</span><span class="identifier">weak_ptr</span><span class="special"><</span><span class="identifier">T</span><span class="special">></span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">a</span><span class="special">,</span> <span class="identifier">weak_ptr</span><span class="special"><</span><span class="identifier">U</span><span class="special">></span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">b</span><span class="special">);</span>
<span class="comment">// [2.2.4.7] weak_ptr specialized algorithms</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">></span> <span class="keyword">void</span> <span class="identifier">swap</span><span class="special">(</span><span class="identifier">weak_ptr</span><span class="special"><</span><span class="identifier">T</span><span class="special">>&</span> <span class="identifier">a</span><span class="special">,</span> <span class="identifier">weak_ptr</span><span class="special"><</span><span class="identifier">T</span><span class="special">>&</span> <span class="identifier">b</span><span class="special">);</span>
<span class="comment">// [2.2.5] Class enable_shared_from_this</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">></span> <span class="keyword">class</span> <span class="identifier">enable_shared_from_this</span><span class="special">;</span>
<span class="special">}</span> <span class="comment">// namespace tr1</span>
<span class="special">}</span> <span class="comment">// namespace std</span>
</pre>
<p>
<span class="bold"><strong>Configuration:</strong></span> <a href="../../../libs/config/index.html" target="_top">Boost.Config</a>
should (automatically) define the macro BOOST_HAS_TR1_SHARED_PTR if your
standard library implements this part of TR1.
</p>
<p>
<span class="bold"><strong>Standard Conformity:</strong></span> There are no known
deviations from the standard when using the Boost version of this component.
</p>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_tr1.subject_list.result_of"></a><a class="link" href="subject_list.html#boost_tr1.subject_list.result_of" title="Class template result_of.">Class template result_of.</a>
</h3></div></div></div>
<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">tr1</span><span class="special">/</span><span class="identifier">functional</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
</pre>
<p>
or
</p>
<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">functional</span><span class="special">></span>
</pre>
<p>
The class template <code class="computeroutput"><span class="identifier">result_of</span></code>
helps determine the type of a call expression. Given an lvalue <code class="computeroutput"><span class="identifier">f</span></code> of type <code class="computeroutput"><span class="identifier">F</span></code>
and lvalues <code class="computeroutput"><span class="identifier">t1</span></code>, <code class="computeroutput"><span class="identifier">t2</span><span class="special">,</span> <span class="special">...,</span>
<span class="identifier">tN</span></code> of types <code class="computeroutput"><span class="identifier">T1</span><span class="special">,</span> <span class="identifier">T2</span><span class="special">,</span>
<span class="special">...,</span> <span class="identifier">TN</span></code>,
respectively, the type <code class="computeroutput"><span class="identifier">result_of</span><span class="special"><</span><span class="identifier">F</span><span class="special">(</span><span class="identifier">T1</span><span class="special">,</span> <span class="identifier">T2</span><span class="special">,</span> <span class="special">...,</span> <span class="identifier">TN</span><span class="special">)>::</span><span class="identifier">type</span></code>
defines the result type of the expression <code class="computeroutput"><span class="identifier">f</span><span class="special">(</span><span class="identifier">t1</span><span class="special">,</span>
<span class="identifier">t2</span><span class="special">,</span> <span class="special">...,</span><span class="identifier">tN</span><span class="special">)</span></code>. The implementation permits the type <code class="computeroutput"><span class="identifier">F</span></code> to be a function pointer, function reference,
member function pointer, or class type. For more information <a href="../../../libs/utility/utility.htm#result_of" target="_top">refer
to the Boost.Utility documentation.</a>
</p>
<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">std</span> <span class="special">{</span>
<span class="keyword">namespace</span> <span class="identifier">tr1</span> <span class="special">{</span>
<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">></span>
<span class="keyword">struct</span> <span class="identifier">result_of</span>
<span class="special">{</span>
<span class="keyword">typedef</span> <span class="identifier">unspecified</span> <span class="identifier">type</span><span class="special">;</span>
<span class="special">};</span>
<span class="special">}</span> <span class="comment">// namespace tr1</span>
<span class="special">}</span> <span class="comment">// namespace std</span>
</pre>
<p>
<span class="bold"><strong>Configuration:</strong></span> <a href="../../../libs/config/index.html" target="_top">Boost.Config</a>
should (automatically) define the macro BOOST_HAS_TR1_RESULT_OF if your standard
library implements this part of TR1.
</p>
<p>
<span class="bold"><strong>Standard Conformity:</strong></span> No known problems.
</p>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_tr1.subject_list.mem_fn"></a><a class="link" href="subject_list.html#boost_tr1.subject_list.mem_fn" title="Function template mem_fn.">Function template mem_fn.</a>
</h3></div></div></div>
<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">tr1</span><span class="special">/</span><span class="identifier">functional</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
</pre>
<p>
or
</p>
<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">functional</span><span class="special">></span>
</pre>
<p>
<code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">tr1</span><span class="special">::</span><span class="identifier">mem_fn</span></code>
is a generalization of the standard functions <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">mem_fun</span></code>
and <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">mem_fun_ref</span></code>. It supports member function
pointers with more than one argument, and the returned function object can
take a pointer, a reference, or a smart pointer to an object instance as
its first argument. <code class="computeroutput"><span class="identifier">mem_fn</span></code>
also supports pointers to data members by treating them as functions taking
no arguments and returning a (const) reference to the member. For more information
refer to the <a href="../../../libs/bind/mem_fn.html" target="_top">Boost.Mem_fn documentation</a>.
</p>
<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">std</span> <span class="special">{</span>
<span class="keyword">namespace</span> <span class="identifier">tr1</span> <span class="special">{</span>
<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T</span><span class="special">></span> <span class="identifier">unspecified</span> <span class="identifier">mem_fn</span><span class="special">(</span><span class="identifier">R</span> <span class="identifier">T</span><span class="special">::*</span> <span class="identifier">pm</span><span class="special">);</span>
<span class="special">}</span> <span class="comment">// namespace tr1</span>
<span class="special">}</span> <span class="comment">// namespace std</span>
</pre>
<p>
<span class="bold"><strong>Configuration:</strong></span> <a href="../../../libs/config/index.html" target="_top">Boost.Config</a>
should (automatically) define the macro BOOST_HAS_TR1_MEM_FN if your standard
library implements this part of TR1.
</p>
<p>
<span class="bold"><strong>Standard Conformity:</strong></span> The Boost implementation
does not produce functors that inherit from <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">unary_function</span></code>
or <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">binary_function</span></code>, nor does it function correctly
with pointers to volatile member functions (these should be extremely rare
in practice however).
</p>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_tr1.subject_list.bind"></a><a class="link" href="subject_list.html#boost_tr1.subject_list.bind" title="Function Object Binders.">Function Object Binders.</a>
</h3></div></div></div>
<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">tr1</span><span class="special">/</span><span class="identifier">functional</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
</pre>
<p>
or
</p>
<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">functional</span><span class="special">></span>
</pre>
<p>
<code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">tr1</span><span class="special">::</span><span class="identifier">bind</span></code>
is a generalization of the standard functions <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">bind1st</span></code>
and <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">bind2nd</span></code>. It supports arbitrary function
objects, functions, function pointers, and member function pointers, and
is able to bind any argument to a specific value or route input arguments
into arbitrary positions. <code class="computeroutput"><span class="identifier">bind</span></code>
does not place any requirements on the function object; in particular, it
does not need the <code class="computeroutput"><span class="identifier">result_type</span></code>,
<code class="computeroutput"><span class="identifier">first_argument_type</span></code> and
<code class="computeroutput"><span class="identifier">second_argument_type</span></code> standard
typedefs. For more information refer to the <a href="../../../libs/bind/bind.html" target="_top">Boost.Bind
documentation</a>.
</p>
<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">std</span> <span class="special">{</span>
<span class="keyword">namespace</span> <span class="identifier">tr1</span> <span class="special">{</span>
<span class="comment">// [3.6] Function object binders</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">></span> <span class="keyword">struct</span> <span class="identifier">is_bind_expression</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">></span> <span class="keyword">struct</span> <span class="identifier">is_placeholder</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">F</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T1</span><span class="special">,</span> <span class="special">...,</span> <span class="keyword">class</span> <span class="identifier">Tn</span> <span class="special">></span> <span class="identifier">unspecified</span> <span class="identifier">bind</span><span class="special">(</span><span class="identifier">F</span> <span class="identifier">f</span><span class="special">,</span> <span class="identifier">T1</span> <span class="identifier">t1</span><span class="special">,</span> <span class="special">...,</span> <span class="identifier">Tn</span> <span class="identifier">tn</span> <span class="special">);</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">F</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">T1</span><span class="special">,</span> <span class="special">...,</span> <span class="keyword">class</span> <span class="identifier">Tn</span> <span class="special">></span> <span class="identifier">unspecified</span> <span class="identifier">bind</span><span class="special">(</span><span class="identifier">F</span> <span class="identifier">f</span><span class="special">,</span> <span class="identifier">T1</span> <span class="identifier">t1</span><span class="special">,</span> <span class="special">...,</span> <span class="identifier">Tn</span> <span class="identifier">tn</span> <span class="special">);</span>
<span class="keyword">namespace</span> <span class="identifier">placeholders</span> <span class="special">{</span>
<span class="comment">// M is the implementation-defined number of placeholders</span>
<span class="keyword">extern</span> <span class="identifier">unspecified</span> <span class="identifier">_1</span><span class="special">;</span>
<span class="keyword">extern</span> <span class="identifier">unspecified</span> <span class="identifier">_2</span><span class="special">;</span>
<span class="special">.</span>
<span class="special">.</span>
<span class="special">.</span>
<span class="keyword">extern</span> <span class="identifier">unspecified</span> <span class="identifier">_M</span><span class="special">;</span>
<span class="special">}</span>
<span class="special">}</span> <span class="comment">// namespace tr1</span>
<span class="special">}</span> <span class="comment">// namespace std</span>
</pre>
<p>
<span class="bold"><strong>Configuration:</strong></span> <a href="../../../libs/config/index.html" target="_top">Boost.Config</a>
should (automatically) define the macro BOOST_HAS_TR1_BIND if your standard
library implements this part of TR1.
</p>
<p>
<span class="bold"><strong>Standard Conformity:</strong></span> The traits classes
<code class="computeroutput"><span class="identifier">is_placeholder</span></code> and <code class="computeroutput"><span class="identifier">is_bind_expression</span></code> are not supported by
the Boost implementation.
</p>
<p>
The named return value syntax isn't supported if the object being bound is
a function pointer, for example:
</p>
<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">tr1</span><span class="special">::</span><span class="identifier">bind</span><span class="special">(&</span><span class="identifier">my_proc</span><span class="special">,</span> <span class="identifier">arg1</span><span class="special">,</span> <span class="identifier">arg2</span> <span class="comment">/* etc */</span><span class="special">);</span> <span class="comment">// works OK.</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">tr1</span><span class="special">::</span><span class="identifier">bind</span><span class="special"><</span><span class="keyword">double</span><span class="special">>(&</span><span class="identifier">my_proc</span><span class="special">,</span> <span class="identifier">arg1</span><span class="special">,</span> <span class="identifier">arg2</span> <span class="comment">/* etc */</span><span class="special">);</span> <span class="comment">// causes compiler error.</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">tr1</span><span class="special">::</span><span class="identifier">bind</span><span class="special"><</span><span class="keyword">double</span><span class="special">>(</span><span class="identifier">my_function_object</span><span class="special">,</span> <span class="identifier">arg1</span><span class="special">,</span> <span class="identifier">arg2</span> <span class="comment">/* etc */</span><span class="special">);</span> <span class="comment">// works OK.</span>
</pre>
<p>
On the other hand, the Boost implementation does work with pointers to overloaded
functions, and optionally with function pointers with non-standard calling
conventions.
</p>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_tr1.subject_list.function"></a><a class="link" href="subject_list.html#boost_tr1.subject_list.function" title="Polymorphic function wrappers.">Polymorphic function
wrappers.</a>
</h3></div></div></div>
<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">tr1</span><span class="special">/</span><span class="identifier">functional</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
</pre>
<p>
or
</p>
<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">functional</span><span class="special">></span>
</pre>
<p>
The polymorphic function wrappers are a family of class templates that may
be used as a generalized callback mechanism. A polymorphic function wrapper
shares features with function pointers, in that both define a call interface
(for example a function taking two integer arguments and returning a floating-point
value) through which some arbitrary code may be called. However a polymorphic
function wrapper can call any callable object with a compatible call signature,
this could be a function pointer, or it could be a function object produced
by std::tr1::bind, or some other mechanism. For more information see the
<a href="../../../doc/html/function.html" target="_top">Boost.Function documentation</a>.
</p>
<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">std</span> <span class="special">{</span>
<span class="keyword">namespace</span> <span class="identifier">tr1</span> <span class="special">{</span>
<span class="comment">// [3.7] polymorphic function wrappers</span>
<span class="keyword">class</span> <span class="identifier">bad_function_call</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">Function</span><span class="special">></span>
<span class="keyword">class</span> <span class="identifier">function</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">Function</span><span class="special">></span>
<span class="keyword">void</span> <span class="identifier">swap</span><span class="special">(</span><span class="identifier">function</span><span class="special"><</span><span class="identifier">Function</span><span class="special">>&,</span> <span class="identifier">function</span><span class="special"><</span><span class="identifier">Function</span><span class="special">>&);</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">Function1</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Function2</span><span class="special">></span>
<span class="keyword">void</span> <span class="keyword">operator</span><span class="special">==(</span><span class="keyword">const</span> <span class="identifier">function</span><span class="special"><</span><span class="identifier">Function1</span><span class="special">>&,</span> <span class="keyword">const</span> <span class="identifier">function</span><span class="special"><</span><span class="identifier">Function2</span><span class="special">>&);</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">Function1</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Function2</span><span class="special">></span>
<span class="keyword">void</span> <span class="keyword">operator</span><span class="special">!=(</span><span class="keyword">const</span> <span class="identifier">function</span><span class="special"><</span><span class="identifier">Function1</span><span class="special">>&,</span> <span class="keyword">const</span> <span class="identifier">function</span><span class="special"><</span><span class="identifier">Function2</span><span class="special">>&);</span>
<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">Function</span><span class="special">></span>
<span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">==(</span><span class="keyword">const</span> <span class="identifier">function</span><span class="special"><</span><span class="identifier">Function</span><span class="special">>&,</span> <span class="identifier">unspecified</span><span class="special">-</span><span class="identifier">null</span><span class="special">-</span><span class="identifier">pointer</span><span class="special">-</span><span class="identifier">type</span> <span class="special">);</span>
<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">Function</span><span class="special">></span>
<span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">==(</span><span class="identifier">unspecified</span><span class="special">-</span><span class="identifier">null</span><span class="special">-</span><span class="identifier">pointer</span><span class="special">-</span><span class="identifier">type</span> <span class="special">,</span> <span class="keyword">const</span> <span class="identifier">function</span><span class="special"><</span><span class="identifier">Function</span><span class="special">>&);</span>
<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">Function</span><span class="special">></span>
<span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">!=(</span><span class="keyword">const</span> <span class="identifier">function</span><span class="special"><</span><span class="identifier">Function</span><span class="special">>&,</span> <span class="identifier">unspecified</span><span class="special">-</span><span class="identifier">null</span><span class="special">-</span><span class="identifier">pointer</span><span class="special">-</span><span class="identifier">type</span> <span class="special">);</span>
<span class="keyword">template</span> <span class="special"><</span><span class="keyword">class</span> <span class="identifier">Function</span><span class="special">></span>
<span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">!=(</span><span class="identifier">unspecified</span><span class="special">-</span><span class="identifier">null</span><span class="special">-</span><span class="identifier">pointer</span><span class="special">-</span><span class="identifier">type</span> <span class="special">,</span> <span class="keyword">const</span> <span class="identifier">function</span><span class="special"><</span><span class="identifier">Function</span><span class="special">>&);</span>
<span class="special">}</span> <span class="comment">// namespace tr1</span>
<span class="special">}</span> <span class="comment">// namespace std</span>
</pre>
<p>
<span class="bold"><strong>Configuration:</strong></span> <a href="../../../libs/config/index.html" target="_top">Boost.Config</a>
should (automatically) define the macro BOOST_HAS_TR1_FUNCTION if your standard
library implements this part of TR1.
</p>
<p>
<span class="bold"><strong>Standard Conformity:</strong></span> The Boost version of
<code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">tr1</span><span class="special">::</span><span class="identifier">function</span></code>
lacks the member function <code class="computeroutput"><span class="identifier">target_type</span><span class="special">()</span></code> and does not inherit from <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">unary_function</span></code>
or <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">binary_function</span></code> when applicable. The member
function target() can only access pointer-to-member targets when they have
been wrapped in mem_fn.
</p>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_tr1.subject_list.type_traits"></a><a class="link" href="subject_list.html#boost_tr1.subject_list.type_traits" title="Type Traits.">Type Traits.</a>
</h3></div></div></div>
<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">tr1</span><span class="special">/</span><span class="identifier">type_traits</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
</pre>
<p>
or
</p>
<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">type_traits</span><span class="special">></span>
</pre>
<p>
Type traits enable generic code to access the fundamental properties of a
type, to determine the relationship between two types, or to transform one
type into another related type. For more information refer to the <a href="../../../libs/type_traits/index.html" target="_top">Boost.Type_traits documentation</a>.
</p>
<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">std</span> <span class="special">{</span>
<span class="keyword">namespace</span> <span class="identifier">tr1