forked from boostorg/fusion
Fusion: added nview and friends, docs and tests
[SVN r56377]
This commit is contained in:
Hartmut Kaiser
@ -3,12 +3,11 @@
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
||||
<title>invoke</title>
|
||||
<link rel="stylesheet" href="../../../../../../../../doc/html/boostbook.css" type="text/css">
|
||||
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
|
||||
<meta name="generator" content="DocBook XSL Stylesheets V1.75.0">
|
||||
<link rel="home" href="../../../../index.html" title="Chapter<65>1.<2E>Fusion 2.0">
|
||||
<link rel="up" href="../functions.html" title="Functions">
|
||||
<link rel="previous" href="../functions.html" title="Functions">
|
||||
<link rel="next" href="invoke_proc.html" title="
|
||||
invoke_procedure">
|
||||
<link rel="prev" href="../functions.html" title="Functions">
|
||||
<link rel="next" href="invoke_proc.html" title="invoke_procedure">
|
||||
</head>
|
||||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||||
<table cellpadding="2" width="100%"><tr>
|
||||
@ -23,21 +22,17 @@
|
||||
<div class="spirit-nav">
|
||||
<a accesskey="p" href="../functions.html"><img src="../../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../functions.html"><img src="../../../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="invoke_proc.html"><img src="../../../../../../../../doc/html/images/next.png" alt="Next"></a>
|
||||
</div>
|
||||
<div class="section" lang="en">
|
||||
<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></div>
|
||||
</div>
|
||||
<div class="section" title="invoke">
|
||||
<div class="titlepage"><div><div><h5 class="title">
|
||||
<a name="fusion.functional.invocation.functions.invoke"></a><a class="link" href="invoke.html" title="invoke">invoke</a>
|
||||
</h5></div></div></div>
|
||||
<a name="fusion.functional.invocation.functions.invoke.description"></a><h6>
|
||||
<a name="id610701"></a>
|
||||
<a href="invoke.html#fusion.functional.invocation.functions.invoke.description">Description</a>
|
||||
<a name="id760969"></a>
|
||||
<a class="link" href="invoke.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="../../../sequence.html" title="Sequence">Sequence</a>.
|
||||
Calls a <a class="link" href="../../concepts/def_callable.html" title="Deferred Callable Object">Deferred
|
||||
Callable Object</a> with the arguments from a <a class="link" href="../../../sequence.html" title="Sequence">Sequence</a>.
|
||||
</p>
|
||||
<p>
|
||||
The first template parameter can be specialized explicitly to avoid copying
|
||||
@ -46,34 +41,34 @@
|
||||
<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 <tt class="literal">get_pointer</tt> function
|
||||
must be defined (Boost provides this function for <tt class="literal">std::auto_ptr</tt>
|
||||
and <a href="http://www.boost.org/libs/smart_ptr/shared_ptr.htm" target="_top"><tt class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">shared_ptr</span></tt></a>).
|
||||
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/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>
|
||||
Constructors can be called applying <a href="http://www.boost.org/libs/functional/factory/doc/html/index.html" target="_top">Boost.Functional/Factory</a>.
|
||||
</p>
|
||||
<a name="fusion.functional.invocation.functions.invoke.synopsis"></a><h6>
|
||||
<a name="id610814"></a>
|
||||
<a href="invoke.html#fusion.functional.invocation.functions.invoke.synopsis">Synopsis</a>
|
||||
<a name="id761040"></a>
|
||||
<a class="link" href="invoke.html#fusion.functional.invocation.functions.invoke.synopsis">Synopsis</a>
|
||||
</h6>
|
||||
<pre class="programlisting"><span class="keyword">template</span><span class="special"><</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">></span>
|
||||
<span class="keyword">typename</span> <a href="../metafunctions/invoke.html" title="invoke"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">invoke</span></tt></a><span class="special"><</span><span class="identifier">Function</span><span class="special">,</span> <span class="identifier">Sequence</span><span class="special">>::</span><span class="identifier">type</span>
|
||||
<span class="keyword">typename</span> <a class="link" 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><span class="special"><</span><span class="identifier">Function</span><span class="special">,</span> <span class="identifier">Sequence</span><span class="special">>::</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">&</span> <span class="identifier">s</span><span class="special">);</span>
|
||||
|
||||
<span class="keyword">template</span><span class="special"><</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">></span>
|
||||
<span class="keyword">typename</span> <a href="../metafunctions/invoke.html" title="invoke"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">invoke</span></tt></a><span class="special"><</span><span class="identifier">Function</span><span class="special">,</span> <span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">>::</span><span class="identifier">type</span>
|
||||
<span class="keyword">typename</span> <a class="link" 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><span class="special"><</span><span class="identifier">Function</span><span class="special">,</span> <span class="identifier">Sequence</span> <span class="keyword">const</span><span class="special">>::</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">&</span> <span class="identifier">s</span><span class="special">);</span>
|
||||
</pre>
|
||||
<a name="fusion.functional.invocation.functions.invoke.parameters"></a><h6>
|
||||
<a name="id611189"></a>
|
||||
<a href="invoke.html#fusion.functional.invocation.functions.invoke.parameters">Parameters</a>
|
||||
<a name="id761306"></a>
|
||||
<a class="link" href="invoke.html#fusion.functional.invocation.functions.invoke.parameters">Parameters</a>
|
||||
</h6>
|
||||
<div class="informaltable"><table class="table">
|
||||
<colgroup>
|
||||
@ -82,88 +77,101 @@
|
||||
<col>
|
||||
</colgroup>
|
||||
<thead><tr>
|
||||
<th><p>
|
||||
<th>
|
||||
<p>
|
||||
Parameter
|
||||
</p></th>
|
||||
<th><p>
|
||||
</p>
|
||||
</th>
|
||||
<th>
|
||||
<p>
|
||||
Requirement
|
||||
</p></th>
|
||||
<th><p>
|
||||
</p>
|
||||
</th>
|
||||
<th>
|
||||
<p>
|
||||
Description
|
||||
</p></th>
|
||||
</p>
|
||||
</th>
|
||||
</tr></thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><p>
|
||||
<tt class="computeroutput"><span class="identifier">f</span></tt>
|
||||
</p></td>
|
||||
<td><p>
|
||||
A <a href="../../concepts/def_callable.html" title=" Deferred
|
||||
Callable Object">Deferred
|
||||
<td>
|
||||
<p>
|
||||
<code class="computeroutput"><span class="identifier">f</span></code>
|
||||
</p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
A <a class="link" href="../../concepts/def_callable.html" title="Deferred Callable Object">Deferred
|
||||
Callable Object</a>
|
||||
</p></td>
|
||||
<td><p>
|
||||
</p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
The function to call.
|
||||
</p></td>
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p>
|
||||
<tt class="computeroutput"><span class="identifier">s</span></tt>
|
||||
</p></td>
|
||||
<td><p>
|
||||
A <a href="../../../sequence/concepts/forward_sequence.html" title="Forward
|
||||
Sequence">Forward
|
||||
<td>
|
||||
<p>
|
||||
<code class="computeroutput"><span class="identifier">s</span></code>
|
||||
</p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
A <a class="link" href="../../../sequence/concepts/forward_sequence.html" title="Forward Sequence">Forward
|
||||
Sequence</a>
|
||||
</p></td>
|
||||
<td><p>
|
||||
</p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
The arguments.
|
||||
</p></td>
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table></div>
|
||||
<a name="fusion.functional.invocation.functions.invoke.expression_semantics"></a><h6>
|
||||
<a name="id611349"></a>
|
||||
<a href="invoke.html#fusion.functional.invocation.functions.invoke.expression_semantics">Expression
|
||||
<a name="id761432"></a>
|
||||
<a class="link" href="invoke.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"><b>Return type</b></span>: Return type of <tt class="computeroutput"><span class="identifier">f</span></tt> when invoked with the elements in
|
||||
<tt class="computeroutput"><span class="identifier">s</span></tt> as its arguments.
|
||||
<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"><b>Semantics</b></span>: Invokes <tt class="computeroutput"><span class="identifier">f</span></tt>
|
||||
with the elements in <tt class="computeroutput"><span class="identifier">s</span></tt>
|
||||
<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="id611482"></a>
|
||||
<a href="invoke.html#fusion.functional.invocation.functions.invoke.header">Header</a>
|
||||
<a name="id762337"></a>
|
||||
<a class="link" href="invoke.html#fusion.functional.invocation.functions.invoke.header">Header</a>
|
||||
</h6>
|
||||
<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</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">></span>
|
||||
</pre>
|
||||
<a name="fusion.functional.invocation.functions.invoke.example"></a><h6>
|
||||
<a name="id611585"></a>
|
||||
<a href="invoke.html#fusion.functional.invocation.functions.invoke.example">Example</a>
|
||||
<a name="id762407"></a>
|
||||
<a class="link" href="invoke.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"><tt class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">plus</span></tt></a><span class="special"><</span><span class="keyword">int</span><span class="special">></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="../../../container/generation/functions/make_vector.html" title="make_vector"><tt class="computeroutput"><span class="identifier">make_vector</span></tt></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 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"><</span><span class="keyword">int</span><span class="special">></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 class="link" href="../../../container/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="id611752"></a>
|
||||
<a href="invoke.html#fusion.functional.invocation.functions.invoke.see_also">See
|
||||
<a name="id762522"></a>
|
||||
<a class="link" href="invoke.html#fusion.functional.invocation.functions.invoke.see_also">See
|
||||
also</a>
|
||||
</h6>
|
||||
<div class="itemizedlist"><ul type="disc">
|
||||
<li><a href="invoke_proc.html" title="
|
||||
invoke_procedure"><tt class="computeroutput"><span class="identifier">invoke_procedure</span></tt></a></li>
|
||||
<li><a href="invoke_fobj.html" title="
|
||||
invoke_function_object"><tt class="computeroutput"><span class="identifier">invoke_function_object</span></tt></a></li>
|
||||
<li><a href="../metafunctions/invoke.html" title="invoke"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">invoke</span></tt></a></li>
|
||||
<li><a href="../../adapters/fused.html" title="fused"><tt class="computeroutput"><span class="identifier">fused</span></tt></a></li>
|
||||
<li><a href="../../generation/functions/mk_fused.html" title="
|
||||
make_fused"><tt class="computeroutput"><span class="identifier">make_fused</span></tt></a></li>
|
||||
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
|
||||
<li class="listitem"><a class="link" href="invoke_proc.html" title="invoke_procedure"><code class="computeroutput"><span class="identifier">invoke_procedure</span></code></a></li>
|
||||
<li class="listitem"><a class="link" href="invoke_fobj.html" title="invoke_function_object"><code class="computeroutput"><span class="identifier">invoke_function_object</span></code></a></li>
|
||||
<li class="listitem"><a class="link" 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></li>
|
||||
<li class="listitem"><a class="link" href="../../adapters/fused.html" title="fused"><code class="computeroutput"><span class="identifier">fused</span></code></a></li>
|
||||
<li class="listitem"><a class="link" href="../../generation/functions/mk_fused.html" title="make_fused"><code class="computeroutput"><span class="identifier">make_fused</span></code></a></li>
|
||||
</ul></div>
|
||||
</div>
|
||||
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
|
||||
|
||||
Reference in New Issue
Block a user