feedc0de/boost_fusion
1
0
Fork 0
forked from boostorg/fusion
Code Pull Requests Activity
Files
e9a597a1eb77871ed628dd06966d93ac74b6ffea
boost_fusion/doc/html/fusion/functional/invocation/functions.html
Tobias Schwinger 2522e62409 reduces chunk depth (Boost inspection complaints about path length) 
[SVN r37068]
2007-02-25 21:12:10 +00:00

441 lines
34 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Functions</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="../../../index.html" title="Chapter 1. Fusion 2.0">
<link rel="up" href="../invocation.html" title="Invocation">
<link rel="prev" href="../invocation.html" title="Invocation">
<link rel="next" href="metafunctions.html" title="Metafunctions">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../index.htm">Home</a></td>
<td align="center"><a href="../../../../../../libraries.htm">Libraries</a></td>
<td align="center"><a href="../../../../../../../people/people.htm">People</a></td>
<td align="center"><a href="../../../../../../../more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
</table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../invocation.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../invocation.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="metafunctions.html"><img src="../../../images/next.png" alt="Next"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="fusion.functional.invocation.functions"></a><a href="functions.html" title="Functions">Functions</a></h4></div></div></div>
<div class="toc"><dl>
<dt><span class="section"><a href="functions.html#fusion.functional.invocation.functions.invoke">invoke</a></span></dt>
<dt><span class="section"><a href="functions.html#fusion.functional.invocation.functions.invoke_procedure">invoke_procedure</a></span></dt>
<dt><span class="section"><a href="functions.html#fusion.functional.invocation.functions.invoke_function_object">invoke_function_object</a></span></dt>
</dl></div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h5 class="title">
<a name="fusion.functional.invocation.functions.invoke"></a><a href="functions.html#fusion.functional.invocation.functions.invoke" title="invoke">invoke</a></h5></div></div></div>
<a name="fusion.functional.invocation.functions.invoke.description"></a><h6>
<a name="id1187758"></a>
<a href="functions.html#fusion.functional.invocation.functions.invoke.description">Description</a>
</h6>
<p>
Calls a <a href="../concepts/def_callable.html" title=" Deferred
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.html#fusion.functional.invocation.metafunctions.invoke" 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.
</p>
<p>
If the target function is a pointer to a class members, the 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>).
</p>
<a name="fusion.functional.invocation.functions.invoke.synopsis"></a><h6>
<a name="id1187890"></a>
<a href="functions.html#fusion.functional.invocation.functions.invoke.synopsis">Synopsis</a>
</h6>
<pre class="programlisting">
<span class="keyword">template</span><span class="special">&lt;</span>
<span class="keyword">typename</span> <span class="identifier">Function</span><span class="special">,</span>
<span class="keyword">class</span> <span class="identifier">Sequence</span>
<span class="special">&gt;</span>
<span class="keyword">typename</span> <a href="metafunctions.html#fusion.functional.invocation.metafunctions.invoke" title="invoke"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">invoke</span></code></a><span class="special">&lt;</span><span class="identifier">Function</span><span class="special">,</span> <span class="identifier">Sequence</span><span class="special">&gt;::</span><span class="identifier">type</span>
<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="special">&amp;</span> <span class="identifier">s</span><span class="special">);</span>
<span class="keyword">template</span><span class="special">&lt;</span>
<span class="keyword">typename</span> <span class="identifier">Function</span><span class="special">,</span>
<span class="keyword">class</span> <span class="identifier">Sequence</span>
<span class="special">&gt;</span>
<span class="keyword">typename</span> <a href="metafunctions.html#fusion.functional.invocation.metafunctions.invoke" title="invoke"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">invoke</span></code></a><span class="special">&lt;</span><span class="identifier">Function</span><span class="special">,</span> <span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">&gt;::</span><span class="identifier">type</span>
<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="id1188219"></a>
<a href="functions.html#fusion.functional.invocation.functions.invoke.parameters">Parameters</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Parameter</th>
<th>Requirement</th>
<th>Description</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
Callable Object">Deferred
Callable Object</a>
</td>
<td>The function to call.</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
Sequence">Forward
Sequence</a>
</td>
<td>The arguments.</td>
</tr>
</tbody>
</table></div>
<a name="fusion.functional.invocation.functions.invoke.expression_semantics"></a><h6>
<a name="id1188323"></a>
<a href="functions.html#fusion.functional.invocation.functions.invoke.expression_semantics">Expression
Semantics</a>
</h6>
<pre class="programlisting">
<span class="identifier">invoke</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
<code class="computeroutput"><span class="identifier">s</span></code> as its arguments.
</p>
<p>
<span class="bold"><strong>Semantics</strong></span>: Invokes <code class="computeroutput"><span class="identifier">f</span></code>
with the elements in <code class="computeroutput"><span class="identifier">s</span></code>
as arguments and returns the result of the call expression.
</p>
<a name="fusion.functional.invocation.functions.invoke.header"></a><h6>
<a name="id1188330"></a>
<a href="functions.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="id1206005"></a>
<a href="functions.html#fusion.functional.invocation.functions.invoke.example">Example</a>
</h6>
<pre class="programlisting">
<a href="http://www.sgi.com/tech/stl/plus.html" target="_top"><code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">plus</span></code></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">add</span><span class="special">;</span>
<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.html#fusion.sequences.generation.functions.make_vector" 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="id1206156"></a>
<a href="functions.html#fusion.functional.invocation.functions.invoke.see_also">See
also</a>
</h6>
<div class="itemizedlist"><ul type="disc">
<li><a href="functions.html#fusion.functional.invocation.functions.invoke_procedure" title="invoke_procedure"><code class="computeroutput"><span class="identifier">invoke_procedure</span></code></a></li>
<li><a href="functions.html#fusion.functional.invocation.functions.invoke_function_object" title="invoke_function_object"><code class="computeroutput"><span class="identifier">invoke_function_object</span></code></a></li>
<li><a href="metafunctions.html#fusion.functional.invocation.metafunctions.invoke" title="invoke"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">invoke</span></code></a></li>
<li><a href="../adapters/fused.html" title="fused"><code class="computeroutput"><span class="identifier">fused</span></code></a></li>
</ul></div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h5 class="title">
<a name="fusion.functional.invocation.functions.invoke_procedure"></a><a href="functions.html#fusion.functional.invocation.functions.invoke_procedure" title="invoke_procedure">invoke_procedure</a></h5></div></div></div>
<a name="fusion.functional.invocation.functions.invoke_procedure.description"></a><h6>
<a name="id1206291"></a>
<a href="functions.html#fusion.functional.invocation.functions.invoke_procedure.description">Description</a>
</h6>
<p>
Calls a <a href="../concepts/callable.html" title=" Callable Object">Callable
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.
</p>
<p>
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>).
</p>
<p>
The target function must not be a pointer to a member object (dereferencing
such a pointer without returning anything does not make sense, so it
isn't implemented).
</p>
<a name="fusion.functional.invocation.functions.invoke_procedure.synopsis"></a><h6>
<a name="id1206407"></a>
<a href="functions.html#fusion.functional.invocation.functions.invoke_procedure.synopsis">Synopsis</a>
</h6>
<pre class="programlisting">
<span class="keyword">template</span><span class="special">&lt;</span>
<span class="keyword">typename</span> <span class="identifier">Function</span><span class="special">,</span>
<span class="keyword">class</span> <span class="identifier">Sequence</span>
<span class="special">&gt;</span>
<span class="keyword">typename</span> <a href="metafunctions.html#fusion.functional.invocation.metafunctions.invoke_procedure" title="invoke_procedure"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">invoke_procedure</span></code></a><span class="special">&lt;</span><span class="identifier">Function</span><span class="special">,</span> <span class="identifier">Sequence</span><span class="special">&gt;::</span><span class="identifier">type</span>
<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="special">&amp;</span> <span class="identifier">s</span><span class="special">);</span>
<span class="keyword">template</span><span class="special">&lt;</span>
<span class="keyword">typename</span> <span class="identifier">Function</span><span class="special">,</span>
<span class="keyword">class</span> <span class="identifier">Sequence</span>
<span class="special">&gt;</span>
<span class="keyword">typename</span> <a href="metafunctions.html#fusion.functional.invocation.metafunctions.invoke_procedure" title="invoke_procedure"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">invoke_procedure</span></code></a><span class="special">&lt;</span><span class="identifier">Function</span><span class="special">,</span> <span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">&gt;::</span><span class="identifier">type</span>
<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_procedure.parameters"></a><h6>
<a name="id1206741"></a>
<a href="functions.html#fusion.functional.invocation.functions.invoke_procedure.parameters">Parameters</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Parameter</th>
<th>Requirement</th>
<th>Description</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>
</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
Sequence">Forward
Sequence</a>
</td>
<td>The arguments.</td>
</tr>
</tbody>
</table></div>
<a name="fusion.functional.invocation.functions.invoke_procedure.expression_semantics"></a><h6>
<a name="id1206844"></a>
<a href="functions.html#fusion.functional.invocation.functions.invoke_procedure.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>
</pre>
<p>
<span class="bold"><strong>Return type</strong></span>: <code class="computeroutput"><span class="keyword">void</span></code>
</p>
<p>
<span class="bold"><strong>Semantics</strong></span>: Invokes <code class="computeroutput"><span class="identifier">f</span></code>
with the elements in <code class="computeroutput"><span class="identifier">s</span></code>
as arguments.
</p>
<a name="fusion.functional.invocation.functions.invoke_procedure.header"></a><h6>
<a name="id1206851"></a>
<a href="functions.html#fusion.functional.invocation.functions.invoke_procedure.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_procedure.example"></a><h6>
<a name="id1207038"></a>
<a href="functions.html#fusion.functional.invocation.functions.invoke_procedure.example">Example</a>
</h6>
<pre class="programlisting">
<a href="../../sequences/containers/vector.html" title="vector"><code class="computeroutput"><span class="identifier">vector</span></code></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span><span class="keyword">int</span><span class="special">&gt;</span> <span class="identifier">v</span><span class="special">(</span><span class="number">1</span><span class="special">,</span><span class="number">2</span><span class="special">);</span>
<span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">lambda</span><span class="special">;</span>
<span class="identifier">invoke_procedure</span><span class="special">(</span><span class="identifier">_1</span> <span class="special">+=</span> <span class="identifier">_2</span><span class="special">,</span> <span class="identifier">v</span><span class="special">);</span>
<span class="identifier">assert</span><span class="special">(</span><a href="../../sequences/intrinsics/functions.html#fusion.sequences.intrinsics.functions.front" 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_procedure.see_also"></a><h6>
<a name="id1207252"></a>
<a href="functions.html#fusion.functional.invocation.functions.invoke_procedure.see_also">See
also</a>
</h6>
<div class="itemizedlist"><ul type="disc">
<li><a href="functions.html#fusion.functional.invocation.functions.invoke" title="invoke"><code class="computeroutput"><span class="identifier">invoke</span></code></a></li>
<li><a href="functions.html#fusion.functional.invocation.functions.invoke_function_object" title="invoke_function_object"><code class="computeroutput"><span class="identifier">invoke_function_object</span></code></a></li>
<li><a href="metafunctions.html#fusion.functional.invocation.metafunctions.invoke_procedure" title="invoke_procedure"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">invoke_procedure</span></code></a></li>
<li><a href="../adapters/fused_procedure.html" title="fused_procedure"><code class="computeroutput"><span class="identifier">fused_procedure</span></code></a></li>
</ul></div>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h5 class="title">
<a name="fusion.functional.invocation.functions.invoke_function_object"></a><a href="functions.html#fusion.functional.invocation.functions.invoke_function_object" title="invoke_function_object">invoke_function_object</a></h5></div></div></div>
<a name="fusion.functional.invocation.functions.invoke_function_object.description"></a><h6>
<a name="id1207381"></a>
<a href="functions.html#fusion.functional.invocation.functions.invoke_function_object.description">Description</a>
</h6>
<p>
Calls a <a href="../concepts/poly.html" title=" Polymorphic Function
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.html#fusion.functional.invocation.metafunctions.invoke_function_object" 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_function_object.synopsis"></a><h6>
<a name="id1207482"></a>
<a href="functions.html#fusion.functional.invocation.functions.invoke_function_object.synopsis">Synopsis</a>
</h6>
<pre class="programlisting">
<span class="keyword">template</span><span class="special">&lt;</span>
<span class="keyword">typename</span> <span class="identifier">Function</span><span class="special">,</span>
<span class="keyword">class</span> <span class="identifier">Sequence</span>
<span class="special">&gt;</span>
<span class="keyword">typename</span> <a href="metafunctions.html#fusion.functional.invocation.metafunctions.invoke_function_object" 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><span class="special">&lt;</span><span class="identifier">Function</span><span class="special">,</span> <span class="identifier">Sequence</span><span class="special">&gt;::</span><span class="identifier">type</span>
<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="special">&amp;</span> <span class="identifier">s</span><span class="special">);</span>
<span class="keyword">template</span><span class="special">&lt;</span>
<span class="keyword">typename</span> <span class="identifier">Function</span><span class="special">,</span>
<span class="keyword">class</span> <span class="identifier">Sequence</span>
<span class="special">&gt;</span>
<span class="keyword">typename</span> <a href="metafunctions.html#fusion.functional.invocation.metafunctions.invoke_function_object" 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><span class="special">&lt;</span><span class="identifier">Function</span><span class="special">,</span> <span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">&gt;::</span><span class="identifier">type</span>
<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_function_object.parameters"></a><h6>
<a name="id1207814"></a>
<a href="functions.html#fusion.functional.invocation.functions.invoke_function_object.parameters">Parameters</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Parameter</th>
<th>Requirement</th>
<th>Description</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
Object">Polymorphic
Function Object</a>
</td>
<td>The function object to call.</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
Sequence">Forward
Sequence</a>
</td>
<td>The arguments.</td>
</tr>
</tbody>
</table></div>
<a name="fusion.functional.invocation.functions.invoke_function_object.expression_semantics"></a><h6>
<a name="id1207918"></a>
<a href="functions.html#fusion.functional.invocation.functions.invoke_function_object.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>
</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
<code class="computeroutput"><span class="identifier">s</span></code> as its arguments.
</p>
<p>
<span class="bold"><strong>Semantics</strong></span>: Invokes <code class="computeroutput"><span class="identifier">f</span></code>
with the elements in <code class="computeroutput"><span class="identifier">s</span></code>
as arguments and returns the result of the call expression.
</p>
<a name="fusion.functional.invocation.functions.invoke_function_object.header"></a><h6>
<a name="id1208033"></a>
<a href="functions.html#fusion.functional.invocation.functions.invoke_function_object.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_function_object.example"></a><h6>
<a name="id1208128"></a>
<a href="functions.html#fusion.functional.invocation.functions.invoke_function_object.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">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>
<span class="special">{</span>
<span class="keyword">return</span> <span class="identifier">lhs</span> <span class="special">-</span> <span class="identifier">rhs</span><span class="special">;</span>
<span class="special">}</span>
<span class="special">};</span>
<span class="keyword">void</span> <span class="identifier">try_it</span><span class="special">()</span>
<span class="special">{</span>
<span class="identifier">sub</span> <span class="identifier">f</span><span class="special">;</span>
<span class="identifier">assert</span><span class="special">(</span><span class="identifier">f</span><span class="special">(</span><span class="number">2</span><span class="special">,</span><span class="number">1</span><span class="special">)</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><a href="../../sequences/generation/functions.html#fusion.sequences.generation.functions.make_vector" title="make_vector"><code class="computeroutput"><span class="identifier">make_vector</span></code></a><span class="special">(</span><span class="number">2</span><span class="special">,</span><span class="number">1</span><span class="special">)));</span>
<span class="special">}</span>
</pre>
<a name="fusion.functional.invocation.functions.invoke_function_object.see_also"></a><h6>
<a name="id1208510"></a>
<a href="functions.html#fusion.functional.invocation.functions.invoke_function_object.see_also">See
also</a>
</h6>
<div class="itemizedlist"><ul type="disc">
<li><a href="functions.html#fusion.functional.invocation.functions.invoke" title="invoke"><code class="computeroutput"><span class="identifier">invoke</span></code></a></li>
<li><a href="functions.html#fusion.functional.invocation.functions.invoke_procedure" title="invoke_procedure"><code class="computeroutput"><span class="identifier">invoke_procedure</span></code></a></li>
<li><a href="metafunctions.html#fusion.functional.invocation.metafunctions.invoke_function_object" 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></li>
<li><a href="../adapters/fused_function_object.html" title="fused_function_object"><code class="computeroutput"><span class="identifier">fused_function_object</span></code></a></li>
</ul></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"><small>Copyright © 2001-2005 Joel de Guzman, Dan Marsden</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../invocation.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../invocation.html"><img src="../../../images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="metafunctions.html"><img src="../../../images/next.png" alt="Next"></a>
</div>
</body>
</html>
View Git Blame Copy Permalink