diff options
Diffstat (limited to 'doc/html/boost/functionN.html')
-rwxr-xr-x | doc/html/boost/functionN.html | 534 |
1 files changed, 534 insertions, 0 deletions
diff --git a/doc/html/boost/functionN.html b/doc/html/boost/functionN.html new file mode 100755 index 0000000000..f21b9e8984 --- /dev/null +++ b/doc/html/boost/functionN.html @@ -0,0 +1,534 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Class template functionN</title> +<link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../function/reference.html#header.boost.function_hpp" title="Header <boost/function.hpp>"> +<link rel="prev" href="function_base.html" title="Class function_base"> +<link rel="next" href="functionN/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="function_base.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="functionN/sig.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.functionN"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class template functionN</span></h2> +<p>boost::functionN — A set of generalized function pointers 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: <<a class="link" href="../function/reference.html#header.boost.function_hpp" title="Header <boost/function.hpp>">boost/function.hpp</a>> + +</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> R<span class="special">,</span> <span class="keyword">typename</span> T1<span class="special">,</span> <span class="keyword">typename</span> T2<span class="special">,</span> <span class="special">...</span><span class="special">,</span> <span class="keyword">typename</span> TN<span class="special">></span> +<span class="keyword">class</span> <a class="link" href="functionN.html" title="Class template functionN">functionN</a> <span class="special">:</span> <span class="keyword">public</span> <a class="link" href="function_base.html" title="Class function_base">function_base</a> <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.functionN.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.functionN.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.functionN.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.functionN.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.functionN.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.functionN.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.functionN.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 14. Boost.Lambda">Lambda</a> library support</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Args<span class="special">></span> + <span class="keyword">struct</span> <a class="link" href="functionN/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="functionN/sig.html#boost.functionN.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="functionN.html#boost.functionNconstruct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="functionN.html#id741917-bb"><span class="identifier">functionN</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="functionN.html#id425682-bb"><span class="identifier">functionN</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">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> F<span class="special">></span> <a class="link" href="functionN.html#id674348-bb"><span class="identifier">functionN</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"><</span><span class="keyword">typename</span> F<span class="special">,</span> <span class="keyword">typename</span> Allocator<span class="special">></span> <a class="link" href="functionN.html#id738815-bb"><span class="identifier">functionN</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> + functionN& <a class="link" href="functionN.html#id740638-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">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="functionN.html#id702433-bb"><span class="special">~</span><span class="identifier">functionN</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="functionN.html#id692889-bb">modifiers</a></span> + <span class="keyword">void</span> <a class="link" href="functionN.html#id662945-bb"><span class="identifier">swap</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">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="functionN.html#id349645-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="functionN.html#id684310-bb">capacity</a></span> + <span class="keyword">bool</span> <a class="link" href="functionN.html#id661561-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="functionN.html#id676935-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="functionN.html#id741252-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="functionN.html#id680876-bb">target access</a></span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Functor<span class="special">></span> <span class="identifier">Functor</span><span class="special">*</span> <a class="link" href="functionN.html#id724907-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"><</span><span class="keyword">typename</span> Functor<span class="special">></span> <span class="keyword">const</span> <span class="identifier">Functor</span><span class="special">*</span> <a class="link" href="functionN.html#id687993-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"><</span><span class="keyword">typename</span> Functor<span class="special">></span> <span class="keyword">bool</span> <a class="link" href="functionN.html#id445742-bb"><span class="identifier">contains</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Functor</span><span class="special">&</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">&</span> <a class="link" href="functionN.html#id738372-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="functionN.html#id683927-bb">invocation</a></span> + <span class="identifier">result_type</span> <a class="link" href="functionN.html#id749703-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="functionN.html#id750585-bb">specialized algorithms</a></span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T1<span class="special">,</span> <span class="keyword">typename</span> T2<span class="special">,</span> <span class="special">...</span><span class="special">,</span> <span class="keyword">typename</span> TN<span class="special">></span> + <span class="keyword">void</span> <a class="link" href="functionN.html#boost.functionN.swap_id671161"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="functionN.html" title="Class template functionN">functionN</a><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">></span><span class="special">&</span><span class="special">,</span> <a class="link" href="functionN.html" title="Class template functionN">functionN</a><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">></span><span class="special">&</span><span class="special">)</span><span class="special">;</span> + +<span class="comment">// <a class="link" href="functionN.html#id742701-bb">comparison operators</a></span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T1<span class="special">,</span> <span class="keyword">typename</span> T2<span class="special">,</span> <span class="special">...</span><span class="special">,</span> <span class="keyword">typename</span> TN<span class="special">,</span> <span class="keyword">typename</span> Functor<span class="special">></span> + <span class="keyword">bool</span> <a class="link" href="functionN.html#id719607-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"><</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">></span><span class="special">&</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"><</span><span class="keyword">typename</span> T1<span class="special">,</span> <span class="keyword">typename</span> T2<span class="special">,</span> <span class="special">...</span><span class="special">,</span> <span class="keyword">typename</span> TN<span class="special">,</span> <span class="keyword">typename</span> Functor<span class="special">></span> + <span class="keyword">bool</span> <a class="link" href="functionN.html#id745323-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="functionN.html" title="Class template functionN">functionN</a><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">></span><span class="special">&</span><span class="special">)</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T1<span class="special">,</span> <span class="keyword">typename</span> T2<span class="special">,</span> <span class="special">...</span><span class="special">,</span> <span class="keyword">typename</span> TN<span class="special">,</span> <span class="keyword">typename</span> Functor<span class="special">></span> + <span class="keyword">bool</span> <a class="link" href="functionN.html#id371430-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"><</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">></span><span class="special">&</span><span class="special">,</span> + <a class="link" href="reference_wrapper.html" title="Class template reference_wrapper">reference_wrapper</a><span class="special"><</span><span class="identifier">Functor</span><span class="special">></span><span class="special">)</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T1<span class="special">,</span> <span class="keyword">typename</span> T2<span class="special">,</span> <span class="special">...</span><span class="special">,</span> <span class="keyword">typename</span> TN<span class="special">,</span> <span class="keyword">typename</span> Functor<span class="special">></span> + <span class="keyword">bool</span> <a class="link" href="functionN.html#id332978-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><a class="link" href="reference_wrapper.html" title="Class template reference_wrapper">reference_wrapper</a><span class="special"><</span><span class="identifier">Functor</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"><</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">></span><span class="special">&</span><span class="special">)</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T1<span class="special">,</span> <span class="keyword">typename</span> T2<span class="special">,</span> <span class="special">...</span><span class="special">,</span> <span class="keyword">typename</span> TN<span class="special">,</span> <span class="keyword">typename</span> U1<span class="special">,</span> <span class="keyword">typename</span> U2<span class="special">,</span> + <span class="special">...</span><span class="special">,</span> <span class="keyword">typename</span> UN<span class="special">></span> + <span class="keyword">void</span> <a class="link" href="functionN.html#id442127-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"><</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">></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"><</span><span class="identifier">U1</span><span class="special">,</span> <span class="identifier">U2</span><span class="special">,</span> <span class="special">...</span><span class="special">,</span> <span class="identifier">UN</span><span class="special">></span><span class="special">&</span><span class="special">)</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T1<span class="special">,</span> <span class="keyword">typename</span> T2<span class="special">,</span> <span class="special">...</span><span class="special">,</span> <span class="keyword">typename</span> TN<span class="special">,</span> <span class="keyword">typename</span> Functor<span class="special">></span> + <span class="keyword">bool</span> <a class="link" href="functionN.html#id699682-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"><</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">></span><span class="special">&</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"><</span><span class="keyword">typename</span> T1<span class="special">,</span> <span class="keyword">typename</span> T2<span class="special">,</span> <span class="special">...</span><span class="special">,</span> <span class="keyword">typename</span> TN<span class="special">,</span> <span class="keyword">typename</span> Functor<span class="special">></span> + <span class="keyword">bool</span> <a class="link" href="functionN.html#id749405-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="functionN.html" title="Class template functionN">functionN</a><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">></span><span class="special">&</span><span class="special">)</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T1<span class="special">,</span> <span class="keyword">typename</span> T2<span class="special">,</span> <span class="special">...</span><span class="special">,</span> <span class="keyword">typename</span> TN<span class="special">,</span> <span class="keyword">typename</span> Functor<span class="special">></span> + <span class="keyword">bool</span> <a class="link" href="functionN.html#id717373-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"><</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">></span><span class="special">&</span><span class="special">,</span> + <a class="link" href="reference_wrapper.html" title="Class template reference_wrapper">reference_wrapper</a><span class="special"><</span><span class="identifier">Functor</span><span class="special">></span><span class="special">)</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T1<span class="special">,</span> <span class="keyword">typename</span> T2<span class="special">,</span> <span class="special">...</span><span class="special">,</span> <span class="keyword">typename</span> TN<span class="special">,</span> <span class="keyword">typename</span> Functor<span class="special">></span> + <span class="keyword">bool</span> <a class="link" href="functionN.html#id739147-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><a class="link" href="reference_wrapper.html" title="Class template reference_wrapper">reference_wrapper</a><span class="special"><</span><span class="identifier">Functor</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"><</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">></span><span class="special">&</span><span class="special">)</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T1<span class="special">,</span> <span class="keyword">typename</span> T2<span class="special">,</span> <span class="special">...</span><span class="special">,</span> <span class="keyword">typename</span> TN<span class="special">,</span> <span class="keyword">typename</span> U1<span class="special">,</span> <span class="keyword">typename</span> U2<span class="special">,</span> + <span class="special">...</span><span class="special">,</span> <span class="keyword">typename</span> UN<span class="special">></span> + <span class="keyword">void</span> <a class="link" href="functionN.html#id750812-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"><</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">></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"><</span><span class="identifier">U1</span><span class="special">,</span> <span class="identifier">U2</span><span class="special">,</span> <span class="special">...</span><span class="special">,</span> <span class="identifier">UN</span><span class="special">></span><span class="special">&</span><span class="special">)</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id1538950"></a><h2>Description</h2> +<p>Class template <a class="link" href="functionN.html" title="Class template functionN">functionN</a> is + actually a family of related classes <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., up to some + implementation-defined maximum. In this context, <code class="computeroutput">N</code> + refers to the number of parameters.</p> +<div class="refsect2"> +<a name="id1538986"></a><h3> +<a name="boost.functionNconstruct-copy-destruct"></a><code class="computeroutput">functionN</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><a name="id741917-bb"></a><span class="identifier">functionN</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Postconditions:</span></p></td> +<td><code class="computeroutput">this-><a class="link" href="functionN.html#id661561-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="id425682-bb"></a><span class="identifier">functionN</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">&</span> f<span class="special">)</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<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="functionN.html#id661561-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"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> F<span class="special">></span> <a name="id674348-bb"></a><span class="identifier">functionN</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"> +<col align="left" valign="top"> +<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-><a class="link" href="functionN.html#id661561-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"><</span><span class="keyword">typename</span> F<span class="special">,</span> <span class="keyword">typename</span> Allocator<span class="special">></span> <a name="id738815-bb"></a><span class="identifier">functionN</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"> +<col align="left" valign="top"> +<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-><a class="link" href="functionN.html#id661561-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">functionN& <a name="id740638-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">&</span> f<span class="special">)</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<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="functionN.html#id661561-bb">empty</a>()</code>. If copy construction does throw, <code class="computeroutput">this-><a class="link" href="functionN.html#id661561-bb">empty</a>()</code>.</td> +</tr></tbody> +</table></div> +</li> +<li class="listitem"> +<pre class="literallayout"><a name="id702433-bb"></a><span class="special">~</span><span class="identifier">functionN</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Effects:</span></p></td> +<td>If <code class="computeroutput">!this-><a class="link" href="functionN.html#id661561-bb">empty</a>()</code>, destroys the target of this.</td> +</tr></tbody> +</table></div> +</li> +</ol></div> +</div> +<div class="refsect2"> +<a name="id1539575"></a><h3> +<a name="id692889-bb"></a><code class="computeroutput">functionN</code> modifiers</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">void</span> <a name="id662945-bb"></a><span class="identifier">swap</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">&</span> f<span class="special">)</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Effects:</span></p></td> +<td>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="id349645-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"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Postconditions:</span></p></td> +<td>this-><a class="link" href="functionN.html#id661561-bb">empty</a>()</td> +</tr></tbody> +</table></div> +</li> +</ol></div> +</div> +<div class="refsect2"> +<a name="id1539722"></a><h3> +<a name="id684310-bb"></a><code class="computeroutput">functionN</code> capacity</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">bool</span> <a name="id661561-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"> +<col align="left" valign="top"> +<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="id676935-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"> +<col align="left" valign="top"> +<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-><a class="link" href="functionN.html#id661561-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="id741252-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"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td><code class="computeroutput">this-><a class="link" href="functionN.html#id661561-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="id1539978"></a><h3> +<a name="id680876-bb"></a><code class="computeroutput">functionN</code> target access</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><a name="id724904-bb"></a><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Functor<span class="special">></span> <span class="identifier">Functor</span><span class="special">*</span> <a name="id724907-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"><</span><span class="keyword">typename</span> Functor<span class="special">></span> <span class="keyword">const</span> <span class="identifier">Functor</span><span class="special">*</span> <a name="id687993-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"> +<col align="left" valign="top"> +<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"><</span><span class="keyword">typename</span> Functor<span class="special">></span> <span class="keyword">bool</span> <a name="id445742-bb"></a><span class="identifier">contains</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Functor</span><span class="special">&</span> f<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Returns:</span></p></td> +<td> +<code class="computeroutput">true</code> if <code class="computeroutput">this-><a class="link" href="functionN.html#id724904-bb">target</a><Functor>()</code> is non-NULL and <code class="computeroutput"><a class="link" href="function_equal.html" title="Function template function_equal">function_equal</a>(*(this->target<Functor>()), 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">&</span> <a name="id738372-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"> +<col align="left" valign="top"> +<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-><a class="link" href="functionN.html#id661561-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="id1540378"></a><h3> +<a name="id683927-bb"></a><code class="computeroutput">functionN</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="id749703-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"> +<col align="left" valign="top"> +<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-><a class="link" href="functionN.html#id661561-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="id1540704"></a><h3> +<a name="id750585-bb"></a><code class="computeroutput">functionN</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"><</span><span class="keyword">typename</span> T1<span class="special">,</span> <span class="keyword">typename</span> T2<span class="special">,</span> <span class="special">...</span><span class="special">,</span> <span class="keyword">typename</span> TN<span class="special">></span> + <span class="keyword">void</span> <a name="boost.functionN.swap_id671161"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="functionN.html" title="Class template functionN">functionN</a><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">></span><span class="special">&</span> f1<span class="special">,</span> <a class="link" href="functionN.html" title="Class template functionN">functionN</a><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">></span><span class="special">&</span> f2<span class="special">)</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term">Effects:</span></p></td> +<td><code class="computeroutput">f1.<a class="link" href="functionN.html#id662945-bb">swap</a>(f2)</code></td> +</tr></tbody> +</table></div> +</li></ol></div> +</div> +<div class="refsect2"> +<a name="id1540945"></a><h3> +<a name="id742701-bb"></a><code class="computeroutput">functionN</code> comparison operators</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<p><a name="boost.functionN.operator==_id742705"></a></p> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T1<span class="special">,</span> <span class="keyword">typename</span> T2<span class="special">,</span> <span class="special">...</span><span class="special">,</span> <span class="keyword">typename</span> TN<span class="special">,</span> <span class="keyword">typename</span> Functor<span class="special">></span> + <span class="keyword">bool</span> <a name="id719607-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"><</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">></span><span class="special">&</span> f<span class="special">,</span> <span class="identifier">Functor</span> g<span class="special">)</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T1<span class="special">,</span> <span class="keyword">typename</span> T2<span class="special">,</span> <span class="special">...</span><span class="special">,</span> <span class="keyword">typename</span> TN<span class="special">,</span> <span class="keyword">typename</span> Functor<span class="special">></span> + <span class="keyword">bool</span> <a name="id745323-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="identifier">Functor</span> g<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="functionN.html" title="Class template functionN">functionN</a><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">></span><span class="special">&</span> f<span class="special">)</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T1<span class="special">,</span> <span class="keyword">typename</span> T2<span class="special">,</span> <span class="special">...</span><span class="special">,</span> <span class="keyword">typename</span> TN<span class="special">,</span> <span class="keyword">typename</span> Functor<span class="special">></span> + <span class="keyword">bool</span> <a name="id371430-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"><</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">></span><span class="special">&</span> f<span class="special">,</span> + <a class="link" href="reference_wrapper.html" title="Class template reference_wrapper">reference_wrapper</a><span class="special"><</span><span class="identifier">Functor</span><span class="special">></span> g<span class="special">)</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T1<span class="special">,</span> <span class="keyword">typename</span> T2<span class="special">,</span> <span class="special">...</span><span class="special">,</span> <span class="keyword">typename</span> TN<span class="special">,</span> <span class="keyword">typename</span> Functor<span class="special">></span> + <span class="keyword">bool</span> <a name="id332978-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><a class="link" href="reference_wrapper.html" title="Class template reference_wrapper">reference_wrapper</a><span class="special"><</span><span class="identifier">Functor</span><span class="special">></span> g<span class="special">,</span> + <span class="keyword">const</span> <a class="link" href="functionN.html" title="Class template functionN">functionN</a><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">></span><span class="special">&</span> f<span class="special">)</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T1<span class="special">,</span> <span class="keyword">typename</span> T2<span class="special">,</span> <span class="special">...</span><span class="special">,</span> <span class="keyword">typename</span> TN<span class="special">,</span> <span class="keyword">typename</span> U1<span class="special">,</span> <span class="keyword">typename</span> U2<span class="special">,</span> + <span class="special">...</span><span class="special">,</span> <span class="keyword">typename</span> UN<span class="special">></span> + <span class="keyword">void</span> <a name="id442127-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"><</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">></span><span class="special">&</span> f1<span class="special">,</span> + <span class="keyword">const</span> <a class="link" href="functionN.html" title="Class template functionN">functionN</a><span class="special"><</span><span class="identifier">U1</span><span class="special">,</span> <span class="identifier">U2</span><span class="special">,</span> <span class="special">...</span><span class="special">,</span> <span class="identifier">UN</span><span class="special">></span><span class="special">&</span> f2<span class="special">)</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td>True when <code class="computeroutput">f</code> stores an object of + type <code class="computeroutput">Functor</code> and one of the following conditions applies: + <div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> +<code class="computeroutput">g</code> is of type + <code class="computeroutput"><a class="link" href="reference_wrapper.html" title="Class template reference_wrapper">reference_wrapper</a><Functor></code> + and <code class="computeroutput">f.target<Functor>() == g.<a class="link" href="reference_wrapper.html#id1380104-bb">get_pointer</a>()</code>.</li> +<li class="listitem"> +<code class="computeroutput">g</code> is not of type + <code class="computeroutput"><a class="link" href="reference_wrapper.html" title="Class template reference_wrapper">reference_wrapper</a><Functor></code> + and + <code class="computeroutput"><a class="link" href="function_equal.html" title="Function template function_equal">function_equal</a>(*(f.target<Functor>()), + g)</code>.</li> +</ul></div> + </td> +</tr> +<tr> +<td><p><span class="term">Notes:</span></p></td> +<td> +<code class="computeroutput"><a class="link" href="functionN.html" title="Class template functionN">functionN</a></code> + objects are not + <a class="link" href="../EqualityComparable.html" title="Concept EqualityComparable">EqualityComparable</a>.</td> +</tr> +<tr> +<td><p><span class="term">Rationale:</span></p></td> +<td>The <code class="computeroutput">safe_bool</code> conversion + opens a loophole whereby two <code class="computeroutput">functionN</code> + instances can be compared via <code class="computeroutput">==</code>, although this + is not feasible to implement. The undefined <code class="computeroutput">void + operator==</code> closes the loophole and ensures a + compile-time or link-time error.</td> +</tr> +</tbody> +</table></div> +</li> +<li class="listitem"> +<p><a name="boost.functionN.operator!=_id696912"></a></p> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T1<span class="special">,</span> <span class="keyword">typename</span> T2<span class="special">,</span> <span class="special">...</span><span class="special">,</span> <span class="keyword">typename</span> TN<span class="special">,</span> <span class="keyword">typename</span> Functor<span class="special">></span> + <span class="keyword">bool</span> <a name="id699682-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"><</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">></span><span class="special">&</span> f<span class="special">,</span> <span class="identifier">Functor</span> g<span class="special">)</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T1<span class="special">,</span> <span class="keyword">typename</span> T2<span class="special">,</span> <span class="special">...</span><span class="special">,</span> <span class="keyword">typename</span> TN<span class="special">,</span> <span class="keyword">typename</span> Functor<span class="special">></span> + <span class="keyword">bool</span> <a name="id749405-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="identifier">Functor</span> g<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="functionN.html" title="Class template functionN">functionN</a><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">></span><span class="special">&</span> f<span class="special">)</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T1<span class="special">,</span> <span class="keyword">typename</span> T2<span class="special">,</span> <span class="special">...</span><span class="special">,</span> <span class="keyword">typename</span> TN<span class="special">,</span> <span class="keyword">typename</span> Functor<span class="special">></span> + <span class="keyword">bool</span> <a name="id717373-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"><</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">></span><span class="special">&</span> f<span class="special">,</span> + <a class="link" href="reference_wrapper.html" title="Class template reference_wrapper">reference_wrapper</a><span class="special"><</span><span class="identifier">Functor</span><span class="special">></span> g<span class="special">)</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T1<span class="special">,</span> <span class="keyword">typename</span> T2<span class="special">,</span> <span class="special">...</span><span class="special">,</span> <span class="keyword">typename</span> TN<span class="special">,</span> <span class="keyword">typename</span> Functor<span class="special">></span> + <span class="keyword">bool</span> <a name="id739147-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><a class="link" href="reference_wrapper.html" title="Class template reference_wrapper">reference_wrapper</a><span class="special"><</span><span class="identifier">Functor</span><span class="special">></span> g<span class="special">,</span> + <span class="keyword">const</span> <a class="link" href="functionN.html" title="Class template functionN">functionN</a><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">></span><span class="special">&</span> f<span class="special">)</span><span class="special">;</span> +<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T1<span class="special">,</span> <span class="keyword">typename</span> T2<span class="special">,</span> <span class="special">...</span><span class="special">,</span> <span class="keyword">typename</span> TN<span class="special">,</span> <span class="keyword">typename</span> U1<span class="special">,</span> <span class="keyword">typename</span> U2<span class="special">,</span> + <span class="special">...</span><span class="special">,</span> <span class="keyword">typename</span> UN<span class="special">></span> + <span class="keyword">void</span> <a name="id750812-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"><</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">></span><span class="special">&</span> f1<span class="special">,</span> + <span class="keyword">const</span> <a class="link" href="functionN.html" title="Class template functionN">functionN</a><span class="special"><</span><span class="identifier">U1</span><span class="special">,</span> <span class="identifier">U2</span><span class="special">,</span> <span class="special">...</span><span class="special">,</span> <span class="identifier">UN</span><span class="special">></span><span class="special">&</span> f2<span class="special">)</span><span class="special">;</span></pre> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term">Returns:</span></p></td> +<td>True when <code class="computeroutput">f</code> does not store an + object of type <code class="computeroutput">Functor</code> or it stores an object of + type <code class="computeroutput">Functor</code> and one of the following conditions + applies: + <div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> +<code class="computeroutput">g</code> is of type + <code class="computeroutput"><a class="link" href="reference_wrapper.html" title="Class template reference_wrapper">reference_wrapper</a><Functor></code> + and <code class="computeroutput">f.target<Functor>() != g.<a class="link" href="reference_wrapper.html#id1380104-bb">get_pointer</a>()</code>.</li> +<li class="listitem"> +<code class="computeroutput">g</code> is not of type + <code class="computeroutput"><a class="link" href="reference_wrapper.html" title="Class template reference_wrapper">reference_wrapper</a><Functor></code> + and <code class="computeroutput">!<a class="link" href="function_equal.html" title="Function template function_equal">function_equal</a>(*(f.target<Functor>()), g)</code>.</li> +</ul></div> + </td> +</tr> +<tr> +<td><p><span class="term">Notes:</span></p></td> +<td> +<code class="computeroutput"><a class="link" href="functionN.html" title="Class template functionN">functionN</a></code> + objects are not + <a class="link" href="../EqualityComparable.html" title="Concept EqualityComparable">EqualityComparable</a>.</td> +</tr> +<tr> +<td><p><span class="term">Rationale:</span></p></td> +<td>The <code class="computeroutput">safe_bool</code> conversion + opens a loophole whereby two <code class="computeroutput">functionN</code> + instances can be compared via <code class="computeroutput">!=</code>, although this + is not feasible to implement. The undefined <code class="computeroutput">void + operator!=</code> closes the loophole and ensures a + compile-time or link-time error.</td> +</tr> +</tbody> +</table></div> +</li> +</ol></div> +</div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2001-2004 Douglas Gregor<p>Use, modification and distribution is subject to the Boost + Software License, Version 1.0. (See accompanying file + <code class="filename">LICENSE_1_0.txt</code> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)</p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="function_base.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="functionN/sig.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |