UNPKG

boost-react-native-bundle

Version:

Boost library as in https://sourceforge.net/projects/boost/files/boost/1.57.0/

585 lines (574 loc) 64.5 kB
<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Class template function</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="../function/reference.html#header.boost.function_hpp" title="Header &lt;boost/function.hpp&gt;"> <link rel="prev" href="functionN/sig.html" title="Struct template sig"> <link rel="next" href="function/sig.html" title="Struct template sig"> </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="functionN/sig.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../function/reference.html#header.boost.function_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="function/sig.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.function"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Class template function</span></h2> <p>boost::function &#8212; A generalized function pointer that can be used for callbacks or wrapping function objects.</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: &lt;<a class="link" href="../function/reference.html#header.boost.function_hpp" title="Header &lt;boost/function.hpp&gt;">boost/function.hpp</a>&gt; </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Signature<span class="special">&gt;</span> <span class="keyword">class</span> <a class="link" href="function.html" title="Class template function">function</a> <span class="special">:</span> <span class="keyword">public</span> <a class="link" href="functionN.html" title="Class template functionN">functionN</a><span class="special">&lt;</span><span class="identifier">R</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="special">,</span> <span class="identifier">TN</span><span class="special">&gt;</span> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// types</span> <span class="keyword">typedef</span> <span class="identifier">R</span> <a name="boost.function.result_type"></a><span class="identifier">result_type</span><span class="special">;</span> <span class="keyword">typedef</span> <span class="identifier">T1</span> <a name="boost.function.argument_type"></a><span class="identifier">argument_type</span><span class="special">;</span> <span class="comment">// If N == 1</span> <span class="keyword">typedef</span> <span class="identifier">T1</span> <a name="boost.function.first_argument_type"></a><span class="identifier">first_argument_type</span><span class="special">;</span> <span class="comment">// If N == 2</span> <span class="keyword">typedef</span> <span class="identifier">T2</span> <a name="boost.function.second_argument_type"></a><span class="identifier">second_argument_type</span><span class="special">;</span> <span class="comment">// If N == 2</span> <span class="keyword">typedef</span> <span class="identifier">T1</span> <a name="boost.function.arg1_type"></a><span class="identifier">arg1_type</span><span class="special">;</span> <span class="keyword">typedef</span> <span class="identifier">T2</span> <a name="boost.function.arg2_type"></a><span class="identifier">arg2_type</span><span class="special">;</span> . . . <span class="keyword">typedef</span> <span class="identifier">TN</span> <a name="boost.function.argN_type"></a><span class="identifier">argN_type</span><span class="special">;</span> <span class="comment">// static constants</span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">int</span> <span class="identifier">arity</span> = <span class="identifier">N</span><span class="special">;</span> <span class="comment">// member classes/structs/unions</span> <span class="comment">// <a class="link" href="../lambda.html" title="Chapter&#160;16.&#160;Boost.Lambda">Lambda</a> library support</span> <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Args<span class="special">&gt;</span> <span class="keyword">struct</span> <a class="link" href="function/sig.html" title="Struct template sig">sig</a> <span class="special">{</span> <span class="comment">// types</span> <span class="keyword">typedef</span> <span class="identifier">result_type</span> <a class="link" href="function/sig.html#boost.function.sig.type"><span class="identifier">type</span></a><span class="special">;</span> <span class="special">}</span><span class="special">;</span> <span class="comment">// <a class="link" href="function.html#boost.functionconstruct-copy-destruct">construct/copy/destruct</a></span> <a class="link" href="function.html#idp75737696-bb"><span class="identifier">function</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> <a class="link" href="function.html#idp39655760-bb"><span class="identifier">function</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="functionN.html" title="Class template functionN">functionN</a><span class="special">&amp;</span><span class="special">)</span><span class="special">;</span> <a class="link" href="function.html#idp106826448-bb"><span class="identifier">function</span></a><span class="special">(</span><a class="link" href="functionN.html" title="Class template functionN">functionN</a><span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span> <a class="link" href="function.html#idp110867712-bb"><span class="identifier">function</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="function.html" title="Class template function">function</a><span class="special">&amp;</span><span class="special">)</span><span class="special">;</span> <a class="link" href="function.html#idp42720176-bb"><span class="identifier">function</span></a><span class="special">(</span><a class="link" href="function.html" title="Class template function">function</a><span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> F<span class="special">&gt;</span> <a class="link" href="function.html#idp40296688-bb"><span class="identifier">function</span></a><span class="special">(</span><span class="identifier">F</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> F<span class="special">,</span> <span class="keyword">typename</span> Allocator<span class="special">&gt;</span> <a class="link" href="function.html#idp40994480-bb"><span class="identifier">function</span></a><span class="special">(</span><span class="identifier">F</span><span class="special">,</span> <span class="identifier">Allocator</span><span class="special">)</span><span class="special">;</span> function&amp; <a class="link" href="function.html#idp69909120-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="functionN.html" title="Class template functionN">functionN</a><span class="special">&amp;</span><span class="special">)</span><span class="special">;</span> function&amp; <a class="link" href="function.html#idp37708288-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="functionN.html" title="Class template functionN">functionN</a><span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span> function&amp; <a class="link" href="function.html#idp38571792-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="function.html" title="Class template function">function</a><span class="special">&amp;</span><span class="special">)</span><span class="special">;</span> function&amp; <a class="link" href="function.html#idp105085072-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="function.html" title="Class template function">function</a><span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span> <a class="link" href="function.html#idp45860512-bb"><span class="special">~</span><span class="identifier">function</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> <span class="comment">// <a class="link" href="function.html#idp108302096-bb">modifiers</a></span> <span class="keyword">void</span> <a class="link" href="function.html#idp108302656-bb"><span class="identifier">swap</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="function.html" title="Class template function">function</a><span class="special">&amp;</span><span class="special">)</span><span class="special">;</span> <span class="keyword">void</span> <a class="link" href="function.html#idp72870112-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> <span class="comment">// <a class="link" href="function.html#idp99731696-bb">capacity</a></span> <span class="keyword">bool</span> <a class="link" href="function.html#idp39557232-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> <a class="link" href="function.html#idp41154480-bb"><span class="keyword">operator</span> <span class="identifier">safe_bool</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> <span class="keyword">bool</span> <a class="link" href="function.html#idp76193136-bb"><span class="keyword">operator</span><span class="special">!</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> <span class="comment">// <a class="link" href="function.html#idp69032368-bb">target access</a></span> <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Functor<span class="special">&gt;</span> <span class="identifier">Functor</span><span class="special">*</span> <a class="link" href="function.html#idp113597808-bb"><span class="identifier">target</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Functor<span class="special">&gt;</span> <span class="keyword">const</span> <span class="identifier">Functor</span><span class="special">*</span> <a class="link" href="function.html#idp37917680-bb"><span class="identifier">target</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Functor<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="function.html#idp44257488-bb"><span class="identifier">contains</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Functor</span><span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">type_info</span><span class="special">&amp;</span> <a class="link" href="function.html#idp46276608-bb"><span class="identifier">target_type</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> <span class="comment">// <a class="link" href="function.html#idp55139648-bb">invocation</a></span> <span class="identifier">result_type</span> <a class="link" href="function.html#idp55140176-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">arg1_type</span><span class="special">,</span> <span class="identifier">arg2_type</span><span class="special">,</span> <span class="special">...</span><span class="special">,</span> <span class="identifier">argN_type</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span> <span class="comment">// <a class="link" href="function.html#idp111166064-bb">specialized algorithms</a></span> <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Signature<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="function.html#boost.function.swap_idp76190448"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="function.html" title="Class template function">function</a><span class="special">&lt;</span><span class="identifier">Signature</span><span class="special">&gt;</span><span class="special">&amp;</span><span class="special">,</span> <a class="link" href="function.html" title="Class template function">function</a><span class="special">&lt;</span><span class="identifier">Signature</span><span class="special">&gt;</span><span class="special">&amp;</span><span class="special">)</span><span class="special">;</span> <span class="comment">// <a class="link" href="function.html#idp48579440-bb">comparison operators</a></span> <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Signature<span class="special">,</span> <span class="keyword">typename</span> Functor<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="function.html#idp113383552-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="function.html" title="Class template function">function</a><span class="special">&lt;</span><span class="identifier">Signature</span><span class="special">&gt;</span><span class="special">&amp;</span><span class="special">,</span> <span class="identifier">Functor</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Signature<span class="special">,</span> <span class="keyword">typename</span> Functor<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="function.html#idp95785712-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="identifier">Functor</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="function.html" title="Class template function">function</a><span class="special">&lt;</span><span class="identifier">Signature</span><span class="special">&gt;</span><span class="special">&amp;</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Signature<span class="special">,</span> <span class="keyword">typename</span> Functor<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="function.html#idp37641488-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="function.html" title="Class template function">function</a><span class="special">&lt;</span><span class="identifier">Signature</span><span class="special">&gt;</span><span class="special">&amp;</span><span class="special">,</span> reference_wrapper<span class="special">&lt;</span><span class="identifier">Functor</span><span class="special">&gt;</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Signature<span class="special">,</span> <span class="keyword">typename</span> Functor<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="function.html#idp105237024-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span>reference_wrapper<span class="special">&lt;</span><span class="identifier">Functor</span><span class="special">&gt;</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="function.html" title="Class template function">function</a><span class="special">&lt;</span><span class="identifier">Signature</span><span class="special">&gt;</span><span class="special">&amp;</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Signature1<span class="special">,</span> <span class="keyword">typename</span> Signature2<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="function.html#idp69032896-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="function.html" title="Class template function">function</a><span class="special">&lt;</span><span class="identifier">Signature1</span><span class="special">&gt;</span><span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="function.html" title="Class template function">function</a><span class="special">&lt;</span><span class="identifier">Signature2</span><span class="special">&gt;</span><span class="special">&amp;</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Signature<span class="special">,</span> <span class="keyword">typename</span> Functor<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="function.html#idp47556672-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="function.html" title="Class template function">function</a><span class="special">&lt;</span><span class="identifier">Signature</span><span class="special">&gt;</span><span class="special">&amp;</span><span class="special">,</span> <span class="identifier">Functor</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Signature<span class="special">,</span> <span class="keyword">typename</span> Functor<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="function.html#idp101036032-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="identifier">Functor</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="function.html" title="Class template function">function</a><span class="special">&lt;</span><span class="identifier">Signature</span><span class="special">&gt;</span><span class="special">&amp;</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Signature<span class="special">,</span> <span class="keyword">typename</span> Functor<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="function.html#idp54996816-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="function.html" title="Class template function">function</a><span class="special">&lt;</span><span class="identifier">Signature</span><span class="special">&gt;</span><span class="special">&amp;</span><span class="special">,</span> reference_wrapper<span class="special">&lt;</span><span class="identifier">Functor</span><span class="special">&gt;</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Signature<span class="special">,</span> <span class="keyword">typename</span> Functor<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="function.html#idp110874944-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span>reference_wrapper<span class="special">&lt;</span><span class="identifier">Functor</span><span class="special">&gt;</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="function.html" title="Class template function">function</a><span class="special">&lt;</span><span class="identifier">Signature</span><span class="special">&gt;</span><span class="special">&amp;</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Signature1<span class="special">,</span> <span class="keyword">typename</span> Signature2<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="function.html#idp99861584-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="function.html" title="Class template function">function</a><span class="special">&lt;</span><span class="identifier">Signature1</span><span class="special">&gt;</span><span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="function.html" title="Class template function">function</a><span class="special">&lt;</span><span class="identifier">Signature2</span><span class="special">&gt;</span><span class="special">&amp;</span><span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> <a name="idp210007408"></a><h2>Description</h2> <p>Class template <a class="link" href="function.html" title="Class template function">function</a> is a thin wrapper around the numbered class templates <a class="link" href="functionN.html" title="Class template functionN">function0</a>, <a class="link" href="functionN.html" title="Class template functionN">function1</a>, etc. It accepts a function type with N arguments and will will derive from <a class="link" href="functionN.html" title="Class template functionN">functionN</a> instantiated with the arguments it receives.</p> <p>The semantics of all operations in class template <a class="link" href="function.html" title="Class template function">function</a> are equivalent to that of the underlying <a class="link" href="functionN.html" title="Class template functionN">functionN</a> object, although additional member functions are required to allow proper copy construction and copy assignment of function objects.</p> <div class="refsect2"> <a name="idp210014112"></a><h3>Template Parameters</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> <pre class="literallayout"><span class="keyword">typename</span> Signature</pre> <p></p> </li></ol></div> </div> <div class="refsect2"> <a name="idp210016976"></a><h3> <a name="boost.functionconstruct-copy-destruct"></a><code class="computeroutput">function</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> <pre class="literallayout"><a name="idp75737696-bb"></a><span class="identifier">function</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody> <tr> <td><p><span class="term">Postconditions:</span></p></td> <td><code class="computeroutput">this-&gt;<a class="link" href="function.html#idp39557232-bb">empty</a>()</code></td> </tr> <tr> <td><p><span class="term">Throws:</span></p></td> <td>Will not throw.</td> </tr> </tbody> </table></div> </li> <li class="listitem"> <pre class="literallayout"><a name="idp39655760-bb"></a><span class="identifier">function</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="functionN.html" title="Class template functionN">functionN</a><span class="special">&amp;</span> f<span class="special">)</span><span class="special">;</span></pre> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody> <tr> <td><p><span class="term">Postconditions:</span></p></td> <td>Contains a copy of the <code class="computeroutput">f</code>'s target, if it has one, or is empty if <code class="computeroutput">f.<a class="link" href="function.html#idp39557232-bb">empty</a>()</code>.</td> </tr> <tr> <td><p><span class="term">Throws:</span></p></td> <td>Will not throw unless copying the target of <code class="computeroutput">f</code> throws.</td> </tr> </tbody> </table></div> </li> <li class="listitem"> <pre class="literallayout"><a name="idp106826448-bb"></a><span class="identifier">function</span><span class="special">(</span><a class="link" href="functionN.html" title="Class template functionN">functionN</a><span class="special">&amp;&amp;</span> f<span class="special">)</span><span class="special">;</span></pre> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody> <tr> <td><p><span class="term">Requires:</span></p></td> <td>C++11 compatible compiler.</td> </tr> <tr> <td><p><span class="term">Postconditions:</span></p></td> <td>Moves the value from <code class="computeroutput">f</code> to <code class="computeroutput">*this</code>. If the argument has its function object allocated on the heap, its buffer will be assigned to <code class="computeroutput">*this</code> leaving argument empty.</td> </tr> <tr> <td><p><span class="term">Throws:</span></p></td> <td>Will not throw unless argument has its function object allocated not on the heap and copying the target of <code class="computeroutput">f</code> throws.</td> </tr> </tbody> </table></div> </li> <li class="listitem"> <pre class="literallayout"><a name="idp110867712-bb"></a><span class="identifier">function</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="function.html" title="Class template function">function</a><span class="special">&amp;</span> f<span class="special">)</span><span class="special">;</span></pre> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody> <tr> <td><p><span class="term">Postconditions:</span></p></td> <td>Contains a copy of the <code class="computeroutput">f</code>'s target, if it has one, or is empty if <code class="computeroutput">f.<a class="link" href="function.html#idp39557232-bb">empty</a>()</code>.</td> </tr> <tr> <td><p><span class="term">Throws:</span></p></td> <td>Will not throw unless copying the target of <code class="computeroutput">f</code> throws.</td> </tr> </tbody> </table></div> </li> <li class="listitem"> <pre class="literallayout"><a name="idp42720176-bb"></a><span class="identifier">function</span><span class="special">(</span><a class="link" href="function.html" title="Class template function">function</a><span class="special">&amp;&amp;</span> f<span class="special">)</span><span class="special">;</span></pre> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody> <tr> <td><p><span class="term">Requires:</span></p></td> <td>C++11 compatible compiler.</td> </tr> <tr> <td><p><span class="term">Postconditions:</span></p></td> <td>Moves the value from <code class="computeroutput">f</code> to <code class="computeroutput">*this</code>. If the argument has its function object allocated on the heap, its buffer will be assigned to <code class="computeroutput">*this</code> leaving argument empty.</td> </tr> <tr> <td><p><span class="term">Throws:</span></p></td> <td>Will not throw unless argument has its function object allocated not on the heap and copying the target of <code class="computeroutput">f</code> throws.</td> </tr> </tbody> </table></div> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> F<span class="special">&gt;</span> <a name="idp40296688-bb"></a><span class="identifier">function</span><span class="special">(</span><span class="identifier">F</span> f<span class="special">)</span><span class="special">;</span></pre> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody> <tr> <td><p><span class="term">Requires:</span></p></td> <td>F is a function object Callable from <code class="computeroutput">this</code>.</td> </tr> <tr> <td><p><span class="term">Postconditions:</span></p></td> <td> <code class="computeroutput">*this</code> targets a copy of <code class="computeroutput">f</code> if <code class="computeroutput">f</code> is nonempty, or <code class="computeroutput">this-&gt;<a class="link" href="function.html#idp39557232-bb">empty</a>()</code> if <code class="computeroutput">f</code> is empty.</td> </tr> </tbody> </table></div> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> F<span class="special">,</span> <span class="keyword">typename</span> Allocator<span class="special">&gt;</span> <a name="idp40994480-bb"></a><span class="identifier">function</span><span class="special">(</span><span class="identifier">F</span> f<span class="special">,</span> <span class="identifier">Allocator</span> alloc<span class="special">)</span><span class="special">;</span></pre> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody> <tr> <td><p><span class="term">Requires:</span></p></td> <td>F is a function object Callable from <code class="computeroutput">this</code>, Allocator is an allocator. The copy constructor and destructor of Allocator shall not throw.</td> </tr> <tr> <td><p><span class="term">Postconditions:</span></p></td> <td> <code class="computeroutput">*this</code> targets a copy of <code class="computeroutput">f</code> if <code class="computeroutput">f</code> is nonempty, or <code class="computeroutput">this-&gt;<a class="link" href="function.html#idp39557232-bb">empty</a>()</code> if <code class="computeroutput">f</code> is empty.</td> </tr> <tr> <td><p><span class="term">Effects:</span></p></td> <td>If memory allocation is required, the given allocator (or a copy of it) will be used to allocate that memory.</td> </tr> </tbody> </table></div> </li> <li class="listitem"> <pre class="literallayout">function&amp; <a name="idp69909120-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="functionN.html" title="Class template functionN">functionN</a><span class="special">&amp;</span> f<span class="special">)</span><span class="special">;</span></pre> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody><tr> <td><p><span class="term">Postconditions:</span></p></td> <td>If copy construction does not throw, <code class="computeroutput">*this</code> targets a copy of <code class="computeroutput">f</code>'s target, if it has one, or is empty if <code class="computeroutput">f.<a class="link" href="function.html#idp39557232-bb">empty</a>()</code>. If copy construction does throw, <code class="computeroutput">this-&gt;<a class="link" href="function.html#idp39557232-bb">empty</a>()</code>.</td> </tr></tbody> </table></div> </li> <li class="listitem"> <pre class="literallayout">function&amp; <a name="idp37708288-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="functionN.html" title="Class template functionN">functionN</a><span class="special">&amp;&amp;</span> f<span class="special">)</span><span class="special">;</span></pre> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody> <tr> <td><p><span class="term">Requires:</span></p></td> <td>C++11 compatible compiler.</td> </tr> <tr> <td><p><span class="term">Postconditions:</span></p></td> <td>Moves the value from <code class="computeroutput">f</code> to <code class="computeroutput">*this</code>. If the argument has its function object allocated on the heap, its buffer will be assigned to <code class="computeroutput">*this</code> leaving argument empty.</td> </tr> <tr> <td><p><span class="term">Throws:</span></p></td> <td>Will not throw unless argument has its function object allocated not on the heap and copying the target of <code class="computeroutput">f</code> throws.</td> </tr> </tbody> </table></div> </li> <li class="listitem"> <pre class="literallayout">function&amp; <a name="idp38571792-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="function.html" title="Class template function">function</a><span class="special">&amp;</span> f<span class="special">)</span><span class="special">;</span></pre> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody> <tr> <td><p><span class="term">Postconditions:</span></p></td> <td>If copy construction of the target of <code class="computeroutput">f</code> does not throw, <code class="computeroutput">*this</code> targets a copy of <code class="computeroutput">f</code>'s target, if it has one, or is empty if <code class="computeroutput">f.<a class="link" href="function.html#idp39557232-bb">empty</a>()</code>. </td> </tr> <tr> <td><p><span class="term">Throws:</span></p></td> <td>Will not throw when the target of <code class="computeroutput">f</code> is a stateless function object or a reference to the function object. If copy construction does throw, <code class="computeroutput">this-&gt;<a class="link" href="function.html#idp39557232-bb">empty</a>()</code>.</td> </tr> </tbody> </table></div> </li> <li class="listitem"> <pre class="literallayout">function&amp; <a name="idp105085072-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="function.html" title="Class template function">function</a><span class="special">&amp;&amp;</span> f<span class="special">)</span><span class="special">;</span></pre> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody> <tr> <td><p><span class="term">Requires:</span></p></td> <td>C++11 compatible compiler.</td> </tr> <tr> <td><p><span class="term">Postconditions:</span></p></td> <td>Moves the value from <code class="computeroutput">f</code> to <code class="computeroutput">*this</code>. If the argument has its function object allocated on the heap, its buffer will be assigned to <code class="computeroutput">*this</code> leaving argument empty.</td> </tr> <tr> <td><p><span class="term">Throws:</span></p></td> <td>Will not throw unless argument has its function object allocated not on the heap and copying the target of <code class="computeroutput">f</code> throws.</td> </tr> </tbody> </table></div> </li> <li class="listitem"> <pre class="literallayout"><a name="idp45860512-bb"></a><span class="special">~</span><span class="identifier">function</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody><tr> <td><p><span class="term">Effects:</span></p></td> <td>If <code class="computeroutput">!this-&gt;<a class="link" href="function.html#idp39557232-bb">empty</a>()</code>, destroys the target of <code class="computeroutput">this</code>.</td> </tr></tbody> </table></div> </li> </ol></div> </div> <div class="refsect2"> <a name="idp210159696"></a><h3> <a name="idp108302096-bb"></a><code class="computeroutput">function</code> modifiers</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> <pre class="literallayout"><span class="keyword">void</span> <a name="idp108302656-bb"></a><span class="identifier">swap</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="function.html" title="Class template function">function</a><span class="special">&amp;</span> f<span class="special">)</span><span class="special">;</span></pre> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody><tr> <td><p><span class="term">Effects:</span></p></td> <td>Interchanges the targets of <code class="computeroutput">*this</code> and <code class="computeroutput">f</code>.</td> </tr></tbody> </table></div> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">void</span> <a name="idp72870112-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody> <tr> <td><p><span class="term">Postconditions:</span></p></td> <td><code class="computeroutput">this-&gt;<a class="link" href="function.html#idp39557232-bb">empty</a>()</code></td> </tr> <tr> <td><p><span class="term">Throws:</span></p></td> <td>Will not throw.</td> </tr> </tbody> </table></div> </li> </ol></div> </div> <div class="refsect2"> <a name="idp210178832"></a><h3> <a name="idp99731696-bb"></a><code class="computeroutput">function</code> capacity</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> <pre class="literallayout"><span class="keyword">bool</span> <a name="idp39557232-bb"></a><span class="identifier">empty</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody> <tr> <td><p><span class="term">Returns:</span></p></td> <td> <code class="computeroutput">false</code> if <code class="computeroutput">this</code> has a target, and <code class="computeroutput">true</code> otherwise.</td> </tr> <tr> <td><p><span class="term">Throws:</span></p></td> <td>Will not throw.</td> </tr> </tbody> </table></div> </li> <li class="listitem"> <pre class="literallayout"><a name="idp41154480-bb"></a><span class="keyword">operator</span> <span class="identifier">safe_bool</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody> <tr> <td><p><span class="term">Returns:</span></p></td> <td>A <code class="computeroutput">safe_bool</code> that evaluates <code class="computeroutput">false</code> in a boolean context when <code class="computeroutput">this-&gt;<a class="link" href="function.html#idp39557232-bb">empty</a>()</code>, and <code class="computeroutput">true</code> otherwise.</td> </tr> <tr> <td><p><span class="term">Throws:</span></p></td> <td>Will not throw.</td> </tr> </tbody> </table></div> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">bool</span> <a name="idp76193136-bb"></a><span class="keyword">operator</span><span class="special">!</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody> <tr> <td><p><span class="term">Returns:</span></p></td> <td><code class="computeroutput">this-&gt;<a class="link" href="function.html#idp39557232-bb">empty</a>()</code></td> </tr> <tr> <td><p><span class="term">Throws:</span></p></td> <td>Will not throw.</td> </tr> </tbody> </table></div> </li> </ol></div> </div> <div class="refsect2"> <a name="idp210210176"></a><h3> <a name="idp69032368-bb"></a><code class="computeroutput">function</code> target access</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> <pre class="literallayout"><a name="idp113597248-bb"></a><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Functor<span class="special">&gt;</span> <span class="identifier">Functor</span><span class="special">*</span> <a name="idp113597808-bb"></a><span class="identifier">target</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Functor<span class="special">&gt;</span> <span class="keyword">const</span> <span class="identifier">Functor</span><span class="special">*</span> <a name="idp37917680-bb"></a><span class="identifier">target</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody> <tr> <td><p><span class="term">Returns:</span></p></td> <td>If <code class="computeroutput">this</code> stores a target of type <code class="computeroutput">Functor</code>, returns the address of the target. Otherwise, returns the NULL pointer.</td> </tr> <tr> <td><p><span class="term">Throws:</span></p></td> <td>Will not throw.</td> </tr> </tbody> </table></div> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Functor<span class="special">&gt;</span> <span class="keyword">bool</span> <a name="idp44257488-bb"></a><span class="identifier">contains</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Functor</span><span class="special">&amp;</span> f<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody><tr> <td><p><span class="term">Returns:</span></p></td> <td> <code class="computeroutput">true</code> if <code class="computeroutput">this-&gt;<a class="link" href="function.html#idp113597248-bb">target</a>&lt;Functor&gt;()</code> is non-NULL and <code class="computeroutput"><a class="link" href="function_equal.html" title="Function template function_equal">function_equal</a>(*(this-&gt;target&lt;Functor&gt;()), f)</code> </td> </tr></tbody> </table></div> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">type_info</span><span class="special">&amp;</span> <a name="idp46276608-bb"></a><span class="identifier">target_type</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody> <tr> <td><p><span class="term">Returns:</span></p></td> <td> <code class="computeroutput">typeid</code> of the target function object, or <code class="computeroutput">typeid(void)</code> if <code class="computeroutput">this-&gt;<a class="link" href="function.html#idp39557232-bb">empty</a>()</code>.</td> </tr> <tr> <td><p><span class="term">Throws:</span></p></td> <td>Will not throw.</td> </tr> </tbody> </table></div> </li> </ol></div> </div> <div class="refsect2"> <a name="idp210258608"></a><h3> <a name="idp55139648-bb"></a><code class="computeroutput">function</code> invocation</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> <pre class="literallayout"><span class="identifier">result_type</span> <a name="idp55140176-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">arg1_type</span> a1<span class="special">,</span> <span class="identifier">arg2_type</span> a2<span class="special">,</span> <span class="special">...</span><span class="special">,</span> <span class="identifier">argN_type</span> aN<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <div class="variablelist"><table border="0" class="variablelist compact"> <colgroup> <col align="left" valign="top"> <col> </colgroup> <tbody> <tr> <td><p><span class="term">Effects:</span></p></td> <td> <code class="computeroutput">f(a1, a2, ..., aN)</code>, where <code class="computeroutput">f</code> is the target of <code class="computeroutput">*this</code>.</td> </tr> <tr> <td><p><span class="term">Returns:</span></p></td> <td>if <code class="computeroutput">R</code> is <code class="computeroutput">void</code>, nothing is returned; otherwise, the return value of the call to <code class="computeroutput">f</code> is returned.</td> </tr> <tr> <td><p><span class="term">Throws:</span></p></td> <td> <code class="computeroutput"><a class="link" href="bad_function_call.html" title="Class bad_function_call">bad_function_call</a></code> if <code class="computeroutput">this-&gt;<a class="link" href="function.html#idp39557232-bb">empty</a>()</code>. Otherwise, may through any exception thrown by the target function <code class="computeroutput">f</code>.</td> </tr> </tbody> </table></div> </li></ol></div> </div> <div class="refsect2"> <a name="idp210297584"></a><h3> <a name="idp111166064-bb"></a><code class="computeroutput">function</code> specialized algorithms</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Signature<span class="special">&gt;</span> <span class="keyword">void</span> <a name="boost.function.swap_idp76190448"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="function.html" title="Class template function">function</a><span class="special">&lt;</span><span class="identifier">Signature</span><span class="special">&gt;</span><span clas