revises function object concepts and functional module documenation to reflect

boost::result_of-based result computation


[SVN r38209]
This commit is contained in:
Tobias Schwinger
2007-07-13 19:25:34 +00:00
parent f05493abf0
commit 9df373af5f
227 changed files with 10684 additions and 4457 deletions

View File

@ -27,7 +27,7 @@
<div class="titlepage"><div><div><h5 class="title">
<a name="fusion.functional.invocation.functions.invoke"></a><a href="invoke.html" title="invoke">invoke</a></h5></div></div></div>
<a name="fusion.functional.invocation.functions.invoke.description"></a><h6>
<a name="id1187766"></a>
<a name="id1242995"></a>
<a href="invoke.html#fusion.functional.invocation.functions.invoke.description">Description</a>
</h6>
<p>
@ -35,10 +35,6 @@
Callable Object">Deferred
Callable Object</a> with the arguments from a <a href="../../../sequences.html" title="Sequences">Sequence</a>.
</p>
<p>
The corresponding metafunction, <a href="../metafunctions/invoke.html" title="invoke"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">invoke</span></code></a> does not define a <code class="computeroutput"><span class="identifier">type</span></code> member for target functions of
non-class type whose arity is not satisfied by the size of the sequence.
</p>
<p>
The first template parameter can be specialized explicitly to avoid copying
and/or to control the const qualification of a function object.
@ -48,10 +44,10 @@
object can be specified as a reference, pointer, or smart pointer. In
case of the latter, a freestanding <code class="literal">get_pointer</code> function
must be defined (Boost provides this function for <code class="literal">std::auto_ptr</code>
and <a href="http://www.boost.org/libs/smart_ptr/smart_ptr.hpp" target="_top"><code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">shared_ptr</span></code></a>).
and <a href="http://www.boost.org/libs/smart_ptr/shared_ptr.htm" target="_top"><code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">shared_ptr</span></code></a>).
</p>
<a name="fusion.functional.invocation.functions.invoke.synopsis"></a><h6>
<a name="id1187898"></a>
<a name="id1243087"></a>
<a href="invoke.html#fusion.functional.invocation.functions.invoke.synopsis">Synopsis</a>
</h6>
<pre class="programlisting">
@ -70,7 +66,7 @@
<span class="identifier">invoke</span><span class="special">(</span><span class="identifier">Function</span> <span class="identifier">f</span><span class="special">,</span> <span class="identifier">Sequence</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">s</span><span class="special">);</span>
</pre>
<a name="fusion.functional.invocation.functions.invoke.parameters"></a><h6>
<a name="id1188226"></a>
<a name="id1243419"></a>
<a href="invoke.html#fusion.functional.invocation.functions.invoke.parameters">Parameters</a>
</h6>
<div class="informaltable"><table class="table">
@ -80,33 +76,65 @@
<col>
</colgroup>
<thead><tr>
<th>Parameter</th>
<th>Requirement</th>
<th>Description</th>
<th>
<p>
Parameter
</p>
</th>
<th>
<p>
Requirement
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td><code class="computeroutput"><span class="identifier">f</span></code></td>
<td>A
<a href="../../concepts/def_callable.html" title=" Deferred
<td>
<p>
<code class="computeroutput"><span class="identifier">f</span></code>
</p>
</td>
<td>
<p>
A <a href="../../concepts/def_callable.html" title=" Deferred
Callable Object">Deferred
Callable Object</a>
</td>
<td>The function to call.</td>
Callable Object</a>
</p>
</td>
<td>
<p>
The function to call.
</p>
</td>
</tr>
<tr>
<td><code class="computeroutput"><span class="identifier">s</span></code></td>
<td>A
<a href="../../../sequences/concepts/forward_sequence.html" title="Forward
<td>
<p>
<code class="computeroutput"><span class="identifier">s</span></code>
</p>
</td>
<td>
<p>
A <a href="../../../sequences/concepts/forward_sequence.html" title="Forward
Sequence">Forward
Sequence</a>
</td>
<td>The arguments.</td>
Sequence</a>
</p>
</td>
<td>
<p>
The arguments.
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="fusion.functional.invocation.functions.invoke.expression_semantics"></a><h6>
<a name="id1188331"></a>
<a name="id1243565"></a>
<a href="invoke.html#fusion.functional.invocation.functions.invoke.expression_semantics">Expression
Semantics</a>
</h6>
@ -123,14 +151,14 @@
as arguments and returns the result of the call expression.
</p>
<a name="fusion.functional.invocation.functions.invoke.header"></a><h6>
<a name="id1188338"></a>
<a name="id1243684"></a>
<a href="invoke.html#fusion.functional.invocation.functions.invoke.header">Header</a>
</h6>
<pre class="programlisting">
<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">fusion</span><span class="special">/</span><span class="identifier">functional</span><span class="special">/</span><span class="identifier">invocation</span><span class="special">/</span><span class="identifier">invoke</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.functional.invocation.functions.invoke.example"></a><h6>
<a name="id1206013"></a>
<a name="id1243779"></a>
<a href="invoke.html#fusion.functional.invocation.functions.invoke.example">Example</a>
</h6>
<pre class="programlisting">
@ -138,7 +166,7 @@
<span class="identifier">assert</span><span class="special">(</span><span class="identifier">invoke</span><span class="special">(</span><span class="identifier">add</span><span class="special">,</span><a href="../../../sequences/generation/functions/make_vector.html" title="make_vector"><code class="computeroutput"><span class="identifier">make_vector</span></code></a><span class="special">(</span><span class="number">1</span><span class="special">,</span><span class="number">1</span><span class="special">))</span> <span class="special">==</span> <span class="number">2</span><span class="special">);</span>
</pre>
<a name="fusion.functional.invocation.functions.invoke.see_also"></a><h6>
<a name="id1206163"></a>
<a name="id1243931"></a>
<a href="invoke.html#fusion.functional.invocation.functions.invoke.see_also">See
also</a>
</h6>

View File

@ -30,7 +30,7 @@
invoke_function_object">
invoke_function_object</a></h5></div></div></div>
<a name="fusion.functional.invocation.functions.invoke_fobj.description"></a><h6>
<a name="id1207378"></a>
<a name="id1245192"></a>
<a href="invoke_fobj.html#fusion.functional.invocation.functions.invoke_fobj.description">Description</a>
</h6>
<p>
@ -38,19 +38,12 @@
Object">Polymorphic Function
Object</a> with the arguments from a <a href="../../../sequences.html" title="Sequences">Sequence</a>.
</p>
<p>
The corresponding metafunction, <a href="../metafunctions/invoke_fobj.html" title="
invoke_function_object"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">invoke_function_object</span></code></a>, does
not define a <code class="computeroutput"><span class="identifier">type</span></code> member,
if the nested <code class="computeroutput"><span class="identifier">result</span></code>
class template of the target function object is empty.
</p>
<p>
The first template parameter can be specialized explicitly to avoid copying
and/or to control the const qualification of a function object.
</p>
<a name="fusion.functional.invocation.functions.invoke_fobj.synopsis"></a><h6>
<a name="id1207477"></a>
<a name="id1245241"></a>
<a href="invoke_fobj.html#fusion.functional.invocation.functions.invoke_fobj.synopsis">Synopsis</a>
</h6>
<pre class="programlisting">
@ -71,7 +64,7 @@
<span class="identifier">invoke_function_object</span><span class="special">(</span><span class="identifier">Function</span> <span class="identifier">f</span><span class="special">,</span> <span class="identifier">Sequence</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">s</span><span class="special">);</span>
</pre>
<a name="fusion.functional.invocation.functions.invoke_fobj.parameters"></a><h6>
<a name="id1207807"></a>
<a name="id1245574"></a>
<a href="invoke_fobj.html#fusion.functional.invocation.functions.invoke_fobj.parameters">Parameters</a>
</h6>
<div class="informaltable"><table class="table">
@ -81,38 +74,70 @@
<col>
</colgroup>
<thead><tr>
<th>Parameter</th>
<th>Requirement</th>
<th>Description</th>
<th>
<p>
Parameter
</p>
</th>
<th>
<p>
Requirement
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td><code class="computeroutput"><span class="identifier">f</span></code></td>
<td>Model
of <a href="../../concepts/poly.html" title=" Polymorphic Function
<td>
<p>
<code class="computeroutput"><span class="identifier">f</span></code>
</p>
</td>
<td>
<p>
Model of <a href="../../concepts/poly.html" title=" Polymorphic Function
Object">Polymorphic
Function Object</a>
</td>
<td>The function object to call.</td>
Function Object</a>
</p>
</td>
<td>
<p>
The function object to call.
</p>
</td>
</tr>
<tr>
<td><code class="computeroutput"><span class="identifier">s</span></code></td>
<td>Model
of <a href="../../../sequences/concepts/forward_sequence.html" title="Forward
<td>
<p>
<code class="computeroutput"><span class="identifier">s</span></code>
</p>
</td>
<td>
<p>
Model of <a href="../../../sequences/concepts/forward_sequence.html" title="Forward
Sequence">Forward
Sequence</a>
</td>
<td>The arguments.</td>
Sequence</a>
</p>
</td>
<td>
<p>
The arguments.
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="fusion.functional.invocation.functions.invoke_fobj.expression_semantics"></a><h6>
<a name="id1207911"></a>
<a name="id1245720"></a>
<a href="invoke_fobj.html#fusion.functional.invocation.functions.invoke_fobj.expression_semantics">Expression
Semantics</a>
</h6>
<pre class="programlisting">
<span class="identifier">invoke_procedure</span><span class="special">(</span><span class="identifier">f</span><span class="special">,</span><span class="identifier">s</span><span class="special">);</span>
<span class="identifier">invoke_function_object</span><span class="special">(</span><span class="identifier">f</span><span class="special">,</span><span class="identifier">s</span><span class="special">);</span>
</pre>
<p>
<span class="bold"><strong>Return type</strong></span>: Return type of <code class="computeroutput"><span class="identifier">f</span></code> when invoked with the elements in
@ -124,24 +149,25 @@
as arguments and returns the result of the call expression.
</p>
<a name="fusion.functional.invocation.functions.invoke_fobj.header"></a><h6>
<a name="id1207918"></a>
<a name="id1245839"></a>
<a href="invoke_fobj.html#fusion.functional.invocation.functions.invoke_fobj.header">Header</a>
</h6>
<pre class="programlisting">
<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">fusion</span><span class="special">/</span><span class="identifier">functional</span><span class="special">/</span><span class="identifier">invocation</span><span class="special">/</span><span class="identifier">invoke_function_object</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.functional.invocation.functions.invoke_fobj.example"></a><h6>
<a name="id1208116"></a>
<a name="id1245933"></a>
<a href="invoke_fobj.html#fusion.functional.invocation.functions.invoke_fobj.example">Example</a>
</h6>
<pre class="programlisting">
<span class="keyword">struct</span> <span class="identifier">sub</span>
<span class="special">{</span>
<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">_</span><span class="special">&gt;</span>
<span class="keyword">struct</span> <span class="identifier">result</span>
<span class="special">{</span>
<span class="keyword">typedef</span> <span class="identifier">T</span> <span class="identifier">type</span><span class="special">;</span>
<span class="special">};</span>
<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">Sig</span><span class="special">&gt;</span>
<span class="keyword">struct</span> <span class="identifier">result</span><span class="special">;</span>
<span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">Self</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">T</span><span class="special">&gt;</span>
<span class="keyword">struct</span> <span class="identifier">result</span><span class="special">&lt;</span> <span class="identifier">Self</span><span class="special">(</span><span class="identifier">T</span><span class="special">,</span><span class="identifier">T</span><span class="special">)</span> <span class="special">&gt;</span>
<span class="special">{</span> <span class="keyword">typedef</span> <span class="keyword">typename</span> <span class="identifier">remove_reference</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">type</span><span class="special">;</span> <span class="special">};</span>
<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">T</span><span class="special">&gt;</span>
<span class="identifier">T</span> <span class="keyword">operator</span><span class="special">()(</span><span class="identifier">T</span> <span class="identifier">lhs</span><span class="special">,</span> <span class="identifier">T</span> <span class="identifier">rhs</span><span class="special">)</span> <span class="keyword">const</span>
@ -157,7 +183,7 @@
<span class="special">}</span>
</pre>
<a name="fusion.functional.invocation.functions.invoke_fobj.see_also"></a><h6>
<a name="id1208496"></a>
<a name="id1246417"></a>
<a href="invoke_fobj.html#fusion.functional.invocation.functions.invoke_fobj.see_also">See
also</a>
</h6>

View File

@ -30,7 +30,7 @@
invoke_procedure">
invoke_procedure</a></h5></div></div></div>
<a name="fusion.functional.invocation.functions.invoke_proc.description"></a><h6>
<a name="id1206296"></a>
<a name="id1244068"></a>
<a href="invoke_proc.html#fusion.functional.invocation.functions.invoke_proc.description">Description</a>
</h6>
<p>
@ -38,12 +38,6 @@
Object</a> with the arguments from a <a href="../../../sequences.html" title="Sequences">Sequence</a>.
The result of the call is ignored.
</p>
<p>
The corresponding metafunction, __result_of_invoke_procedure, does not
define a <code class="computeroutput"><span class="identifier">type</span></code> member
for target functions of non-class type whose arity is not satisfied by
the size of the sequence.
</p>
<p>
The first template parameter can be specialized explicitly to avoid copying
and/or to control the const qualification of a function object.
@ -52,7 +46,7 @@
For pointers to class members corresponding object can be specified as
a reference, pointer, or smart pointer. In case of the latter, a freestanding
<code class="literal">get_pointer</code> function must be defined (Boost provides
this function for <code class="literal">std::auto_ptr</code> and <a href="http://www.boost.org/libs/smart_ptr/smart_ptr.hpp" target="_top"><code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">shared_ptr</span></code></a>).
this function for <code class="literal">std::auto_ptr</code> and <a href="http://www.boost.org/libs/smart_ptr/shared_ptr.htm" target="_top"><code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">shared_ptr</span></code></a>).
</p>
<p>
The target function must not be a pointer to a member object (dereferencing
@ -60,7 +54,7 @@
isn't implemented).
</p>
<a name="fusion.functional.invocation.functions.invoke_proc.synopsis"></a><h6>
<a name="id1206410"></a>
<a name="id1244168"></a>
<a href="invoke_proc.html#fusion.functional.invocation.functions.invoke_proc.synopsis">Synopsis</a>
</h6>
<pre class="programlisting">
@ -81,7 +75,7 @@
<span class="identifier">invoke_procedure</span><span class="special">(</span><span class="identifier">Function</span> <span class="identifier">f</span><span class="special">,</span> <span class="identifier">Sequence</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="identifier">s</span><span class="special">);</span>
</pre>
<a name="fusion.functional.invocation.functions.invoke_proc.parameters"></a><h6>
<a name="id1206741"></a>
<a name="id1244500"></a>
<a href="invoke_proc.html#fusion.functional.invocation.functions.invoke_proc.parameters">Parameters</a>
</h6>
<div class="informaltable"><table class="table">
@ -91,32 +85,64 @@
<col>
</colgroup>
<thead><tr>
<th>Parameter</th>
<th>Requirement</th>
<th>Description</th>
<th>
<p>
Parameter
</p>
</th>
<th>
<p>
Requirement
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td><code class="computeroutput"><span class="identifier">f</span></code></td>
<td>Model
of <a href="../../concepts/callable.html" title=" Callable Object">Callable
Object</a>
</td>
<td>The function to call.</td>
<td>
<p>
<code class="computeroutput"><span class="identifier">f</span></code>
</p>
</td>
<td>
<p>
Model of <a href="../../concepts/callable.html" title=" Callable Object">Callable
Object</a>
</p>
</td>
<td>
<p>
The function to call.
</p>
</td>
</tr>
<tr>
<td><code class="computeroutput"><span class="identifier">s</span></code></td>
<td>Model
of <a href="../../../sequences/concepts/forward_sequence.html" title="Forward
<td>
<p>
<code class="computeroutput"><span class="identifier">s</span></code>
</p>
</td>
<td>
<p>
Model of <a href="../../../sequences/concepts/forward_sequence.html" title="Forward
Sequence">Forward
Sequence</a>
</td>
<td>The arguments.</td>
Sequence</a>
</p>
</td>
<td>
<p>
The arguments.
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="fusion.functional.invocation.functions.invoke_proc.expression_semantics"></a><h6>
<a name="id1206845"></a>
<a name="id1244645"></a>
<a href="invoke_proc.html#fusion.functional.invocation.functions.invoke_proc.expression_semantics">Expression
Semantics</a>
</h6>
@ -132,14 +158,14 @@
as arguments.
</p>
<a name="fusion.functional.invocation.functions.invoke_proc.header"></a><h6>
<a name="id1206852"></a>
<a name="id1244753"></a>
<a href="invoke_proc.html#fusion.functional.invocation.functions.invoke_proc.header">Header</a>
</h6>
<pre class="programlisting">
<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">fusion</span><span class="special">/</span><span class="identifier">functional</span><span class="special">/</span><span class="identifier">invocation</span><span class="special">/</span><span class="identifier">invoke_procedure</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.functional.invocation.functions.invoke_proc.example"></a><h6>
<a name="id1207040"></a>
<a name="id1244847"></a>
<a href="invoke_proc.html#fusion.functional.invocation.functions.invoke_proc.example">Example</a>
</h6>
<pre class="programlisting">
@ -149,7 +175,7 @@
<span class="identifier">assert</span><span class="special">(</span><a href="../../../sequences/intrinsics/functions/front.html" title="front"><code class="computeroutput"><span class="identifier">front</span></code></a><span class="special">(</span><span class="identifier">v</span><span class="special">)</span> <span class="special">==</span> <span class="number">3</span><span class="special">);</span>
</pre>
<a name="fusion.functional.invocation.functions.invoke_proc.see_also"></a><h6>
<a name="id1207250"></a>
<a name="id1245059"></a>
<a href="invoke_proc.html#fusion.functional.invocation.functions.invoke_proc.see_also">See
also</a>
</h6>

View File

@ -27,18 +27,14 @@
<div class="titlepage"><div><div><h5 class="title">
<a name="fusion.functional.invocation.metafunctions.invoke"></a><a href="invoke.html" title="invoke">invoke</a></h5></div></div></div>
<a name="fusion.functional.invocation.metafunctions.invoke.description"></a><h6>
<a name="id1208642"></a>
<a name="id1246570"></a>
<a href="invoke.html#fusion.functional.invocation.metafunctions.invoke.description">Description</a>
</h6>
<p>
Returns the result type of <a href="../functions/invoke.html" title="invoke"><code class="computeroutput"><span class="identifier">invoke</span></code></a>.
</p>
<p>
Empty for non-class target function types whose arity is not satisfied
by the size of the sequence.
</p>
<a name="fusion.functional.invocation.metafunctions.invoke.synopsis"></a><h6>
<a name="id1208689"></a>
<a name="id1246612"></a>
<a href="invoke.html#fusion.functional.invocation.metafunctions.invoke.synopsis">Synopsis</a>
</h6>
<pre class="programlisting">
@ -55,7 +51,7 @@
<span class="special">}</span>
</pre>
<a name="fusion.functional.invocation.metafunctions.invoke.see_also"></a><h6>
<a name="id1208823"></a>
<a name="id1246748"></a>
<a href="invoke.html#fusion.functional.invocation.metafunctions.invoke.see_also">See
also</a>
</h6>

View File

@ -30,19 +30,15 @@
invoke_function_object">
invoke_function_object</a></h5></div></div></div>
<a name="fusion.functional.invocation.metafunctions.invoke_fobj.description"></a><h6>
<a name="id1209172"></a>
<a name="id1247099"></a>
<a href="invoke_fobj.html#fusion.functional.invocation.metafunctions.invoke_fobj.description">Description</a>
</h6>
<p>
Returns the result type of <a href="../functions/invoke_fobj.html" title="
invoke_function_object"><code class="computeroutput"><span class="identifier">invoke_function_object</span></code></a>.
</p>
<p>
Empty if the target function's nested <code class="computeroutput"><span class="identifier">result</span></code>
class template is empty.
</p>
<a name="fusion.functional.invocation.metafunctions.invoke_fobj.synopsis"></a><h6>
<a name="id1209229"></a>
<a name="id1247143"></a>
<a href="invoke_fobj.html#fusion.functional.invocation.metafunctions.invoke_fobj.synopsis">Synopsis</a>
</h6>
<pre class="programlisting">
@ -59,7 +55,7 @@
<span class="special">}</span>
</pre>
<a name="fusion.functional.invocation.metafunctions.invoke_fobj.see_also"></a><h6>
<a name="id1209363"></a>
<a name="id1247278"></a>
<a href="invoke_fobj.html#fusion.functional.invocation.metafunctions.invoke_fobj.see_also">See
also</a>
</h6>

View File

@ -30,19 +30,15 @@
invoke_procedure">
invoke_procedure</a></h5></div></div></div>
<a name="fusion.functional.invocation.metafunctions.invoke_proc.description"></a><h6>
<a name="id1208906"></a>
<a name="id1246833"></a>
<a href="invoke_proc.html#fusion.functional.invocation.metafunctions.invoke_proc.description">Description</a>
</h6>
<p>
Returns the result type of <a href="../functions/invoke_proc.html" title="
invoke_procedure"><code class="computeroutput"><span class="identifier">invoke_procedure</span></code></a>.
</p>
<p>
Empty for non-class target function types whose arity is not satisfied
by the size of the sequence.
</p>
<a name="fusion.functional.invocation.metafunctions.invoke_proc.synopsis"></a><h6>
<a name="id1208954"></a>
<a name="id1246876"></a>
<a href="invoke_proc.html#fusion.functional.invocation.metafunctions.invoke_proc.synopsis">Synopsis</a>
</h6>
<pre class="programlisting">
@ -59,7 +55,7 @@
<span class="special">}</span>
</pre>
<a name="fusion.functional.invocation.metafunctions.invoke_proc.see_also"></a><h6>
<a name="id1209088"></a>
<a name="id1247012"></a>
<a href="invoke_proc.html#fusion.functional.invocation.metafunctions.invoke_proc.see_also">See
also</a>
</h6>