forked from boostorg/fusion
249 lines
16 KiB
HTML
249 lines
16 KiB
HTML
<html>
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
||
<title>fused_procedure</title>
|
||
<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
|
||
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
|
||
<link rel="home" href="../../../index.html" title="Chapter 1. Fusion 2.0">
|
||
<link rel="up" href="../adapters.html" title=" Adapters">
|
||
<link rel="previous" href="fused.html" title="fused">
|
||
<link rel="next" href="fused_function_object.html" title="fused_function_object">
|
||
</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="../../../../../../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="fused.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../adapters.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="fused_function_object.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
|
||
</div>
|
||
<div class="section" lang="en">
|
||
<div class="titlepage">
|
||
<div><div><h4 class="title">
|
||
<a name="fusion.functional.adapters.fused_procedure"></a><a href="fused_procedure.html" title="fused_procedure">fused_procedure</a>
|
||
</h4></div></div>
|
||
<div></div>
|
||
</div>
|
||
<a name="fusion.functional.adapters.fused_procedure.description"></a><h5>
|
||
<a name="id618918"></a>
|
||
<a href="fused_procedure.html#fusion.functional.adapters.fused_procedure.description">Description</a>
|
||
</h5>
|
||
<p>
|
||
An unary <a href="../concepts/poly.html" title=" Polymorphic Function
|
||
Object">Polymorphic Function
|
||
Object</a> adapter template for <a href="../concepts/callable.html" title=" Callable Object">Callable
|
||
Object</a> target functions. It takes a <a href="../../sequence/concepts/forward_sequence.html" title="Forward
|
||
Sequence">Forward
|
||
Sequence</a> that contains the arguments for the target function.
|
||
</p>
|
||
<p>
|
||
The result is discared and the adapter's return type is <tt class="computeroutput"><span class="keyword">void</span></tt>.
|
||
</p>
|
||
<p>
|
||
The type of the target function is allowed to be const qualified or a reference.
|
||
Const qualification is preserved and propagated appropriately (in other
|
||
words, only const versions of <tt class="literal">operator()</tt> can be used
|
||
for a target function object that is const or, if the target function object
|
||
is held by value, the adapter is const - these semantics have nothing to
|
||
do with the const qualification of a member function, which is referring
|
||
to the type of object pointed to by <tt class="literal">this</tt> which is specified
|
||
with the first element in the sequence passed to the adapter).
|
||
</p>
|
||
<p>
|
||
If the target function is a pointer to a members function, 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>).
|
||
</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 this
|
||
case is not implemented).
|
||
</p>
|
||
<a name="fusion.functional.adapters.fused_procedure.header"></a><h5>
|
||
<a name="id619075"></a>
|
||
<a href="fused_procedure.html#fusion.functional.adapters.fused_procedure.header">Header</a>
|
||
</h5>
|
||
<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">adapter</span><span class="special">/</span><span class="identifier">fused_procedure</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
|
||
</pre>
|
||
<a name="fusion.functional.adapters.fused_procedure.synopsis"></a><h5>
|
||
<a name="id619178"></a>
|
||
<a href="fused_procedure.html#fusion.functional.adapters.fused_procedure.synopsis">Synopsis</a>
|
||
</h5>
|
||
<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">fused_procedure</span><span class="special">;</span>
|
||
</pre>
|
||
<a name="fusion.functional.adapters.fused_procedure.template_parameters"></a><h5>
|
||
<a name="id619256"></a>
|
||
<a href="fused_procedure.html#fusion.functional.adapters.fused_procedure.template_parameters">Template
|
||
parameters</a>
|
||
</h5>
|
||
<div class="informaltable"><table class="table">
|
||
<colgroup>
|
||
<col>
|
||
<col>
|
||
<col>
|
||
</colgroup>
|
||
<thead><tr>
|
||
<th><p>
|
||
Parameter
|
||
</p></th>
|
||
<th><p>
|
||
Description
|
||
</p></th>
|
||
<th><p>
|
||
Default
|
||
</p></th>
|
||
</tr></thead>
|
||
<tbody><tr>
|
||
<td><p>
|
||
<tt class="computeroutput"><span class="identifier">Function</span></tt>
|
||
</p></td>
|
||
<td><p>
|
||
<a href="../concepts/callable.html" title=" Callable Object">Callable Object</a>
|
||
type
|
||
</p></td>
|
||
<td><p>
|
||
</p></td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
<a name="fusion.functional.adapters.fused_procedure.model_of"></a><h5>
|
||
<a name="id619369"></a>
|
||
<a href="fused_procedure.html#fusion.functional.adapters.fused_procedure.model_of">Model
|
||
of</a>
|
||
</h5>
|
||
<div class="itemizedlist"><ul type="disc">
|
||
<li><a href="../concepts/poly.html" title=" Polymorphic Function
|
||
Object">Polymorphic Function
|
||
Object</a></li>
|
||
<li><a href="../concepts/def_callable.html" title=" Deferred
|
||
Callable Object">Deferred Callable
|
||
Object</a></li>
|
||
</ul></div>
|
||
<div class="variablelist">
|
||
<p class="title"><b>Notation</b></p>
|
||
<dl>
|
||
<dt><span class="term"><tt class="computeroutput"><span class="identifier">R</span></tt></span></dt>
|
||
<dd><p>
|
||
A possibly const qualified <a href="../concepts/callable.html" title=" Callable Object">Callable
|
||
Object</a> type or reference type thereof
|
||
</p></dd>
|
||
<dt><span class="term"><tt class="computeroutput"><span class="identifier">r</span></tt></span></dt>
|
||
<dd><p>
|
||
An object convertible to <tt class="computeroutput"><span class="identifier">R</span></tt>
|
||
</p></dd>
|
||
<dt><span class="term"><tt class="computeroutput"><span class="identifier">s</span></tt></span></dt>
|
||
<dd><p>
|
||
A <a href="../../sequence.html" title="Sequence">Sequence</a> of arguments that
|
||
are accepted by <tt class="computeroutput"><span class="identifier">r</span></tt>
|
||
</p></dd>
|
||
<dt><span class="term"><tt class="computeroutput"><span class="identifier">f</span></tt></span></dt>
|
||
<dd><p>
|
||
An instance of <tt class="computeroutput"><span class="identifier">fused</span><span class="special"><</span><span class="identifier">R</span><span class="special">></span></tt>
|
||
</p></dd>
|
||
</dl>
|
||
</div>
|
||
<a name="fusion.functional.adapters.fused_procedure.expression_semantics"></a><h5>
|
||
<a name="id619587"></a>
|
||
<a href="fused_procedure.html#fusion.functional.adapters.fused_procedure.expression_semantics">Expression
|
||
Semantics</a>
|
||
</h5>
|
||
<div class="informaltable"><table class="table">
|
||
<colgroup>
|
||
<col>
|
||
<col>
|
||
</colgroup>
|
||
<thead><tr>
|
||
<th><p>
|
||
Expression
|
||
</p></th>
|
||
<th><p>
|
||
Semantics
|
||
</p></th>
|
||
</tr></thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><p>
|
||
<tt class="computeroutput"><span class="identifier">fused_procedure</span><span class="special"><</span><span class="identifier">R</span><span class="special">>(</span><span class="identifier">r</span><span class="special">)</span></tt>
|
||
</p></td>
|
||
<td><p>
|
||
Creates a fused function as described above, initializes the target
|
||
function with <tt class="computeroutput"><span class="identifier">r</span></tt>.
|
||
</p></td>
|
||
</tr>
|
||
<tr>
|
||
<td><p>
|
||
<tt class="computeroutput"><span class="identifier">fused_procedure</span><span class="special"><</span><span class="identifier">R</span><span class="special">>()</span></tt>
|
||
</p></td>
|
||
<td><p>
|
||
Creates a fused function as described above, attempts to use <tt class="computeroutput"><span class="identifier">R</span></tt>'s default constructor.
|
||
</p></td>
|
||
</tr>
|
||
<tr>
|
||
<td><p>
|
||
<tt class="computeroutput"><span class="identifier">f</span><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></tt>
|
||
</p></td>
|
||
<td><p>
|
||
Calls <tt class="computeroutput"><span class="identifier">r</span></tt> with the
|
||
elements in <tt class="computeroutput"><span class="identifier">s</span></tt> as
|
||
its arguments.
|
||
</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
<a name="fusion.functional.adapters.fused_procedure.example"></a><h5>
|
||
<a name="id619843"></a>
|
||
<a href="fused_procedure.html#fusion.functional.adapters.fused_procedure.example">Example</a>
|
||
</h5>
|
||
<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span> <span class="identifier">SequenceOfSequences</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Func</span><span class="special">></span>
|
||
<span class="keyword">void</span> <span class="identifier">n_ary_for_each</span><span class="special">(</span><span class="identifier">SequenceOfSequences</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">s</span><span class="special">,</span> <span class="identifier">Func</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">f</span><span class="special">)</span>
|
||
<span class="special">{</span>
|
||
<a href="../../algorithm/iteration/functions/for_each.html" title="for_each"><tt class="computeroutput"><span class="identifier">for_each</span></tt></a><span class="special">(</span><a href="../../view/zip_view.html" title="zip_view"><tt class="computeroutput"><span class="identifier">zip_view</span></tt></a><span class="special"><</span><span class="identifier">SequenceOfSequences</span><span class="special">>(</span><span class="identifier">s</span><span class="special">),</span>
|
||
<span class="identifier">fused_procedure</span><span class="special"><</span><span class="identifier">Func</span> <span class="keyword">const</span> <span class="special">&>(</span><span class="identifier">f</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>
|
||
<a href="../../container/vector.html" title="vector"><tt class="computeroutput"><span class="identifier">vector</span></tt></a><span class="special"><</span><span class="keyword">int</span><span class="special">,</span><span class="keyword">float</span><span class="special">></span> <span class="identifier">a</span><span class="special">(</span><span class="number">2</span><span class="special">,</span><span class="number">2.0f</span><span class="special">);</span>
|
||
<a href="../../container/vector.html" title="vector"><tt class="computeroutput"><span class="identifier">vector</span></tt></a><span class="special"><</span><span class="keyword">int</span><span class="special">,</span><span class="keyword">float</span><span class="special">></span> <span class="identifier">b</span><span class="special">(</span><span class="number">1</span><span class="special">,</span><span class="number">1.5f</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">n_ary_for_each</span><span class="special">(</span><a href="../../container/generation/functions/vector_tie.html" title="vector_tie"><tt class="computeroutput"><span class="identifier">vector_tie</span></tt></a><span class="special">(</span><span class="identifier">a</span><span class="special">,</span><span class="identifier">b</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">assert</span><span class="special">(</span><span class="identifier">a</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">0.5f</span><span class="special">));</span>
|
||
<span class="special">}</span>
|
||
</pre>
|
||
<a name="fusion.functional.adapters.fused_procedure.see_also"></a><h5>
|
||
<a name="id620448"></a>
|
||
<a href="fused_procedure.html#fusion.functional.adapters.fused_procedure.see_also">See
|
||
also</a>
|
||
</h5>
|
||
<div class="itemizedlist"><ul type="disc">
|
||
<li><a href="fused.html" title="fused"><tt class="computeroutput"><span class="identifier">fused</span></tt></a></li>
|
||
<li><a href="fused_function_object.html" title="fused_function_object"><tt class="computeroutput"><span class="identifier">fused_function_object</span></tt></a></li>
|
||
<li><a href="../invocation/functions/invoke_proc.html" title="
|
||
invoke_procedure"><tt class="computeroutput"><span class="identifier">invoke_procedure</span></tt></a></li>
|
||
<li><a href="../generation/functions/mk_fused_proc.html" title="
|
||
make_fused_procedure"><tt class="computeroutput"><span class="identifier">make_fused_procedure</span></tt></a></li>
|
||
</ul></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-2007 Joel de Guzman, Dan Marsden, Tobias
|
||
Schwinger<p>
|
||
Distributed under the Boost Software License, Version 1.0. (See accompanying
|
||
file LICENSE_1_0.txt 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="fused.html"><img src="../../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../adapters.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="fused_function_object.html"><img src="../../../../../../../doc/html/images/next.png" alt="Next"></a>
|
||
</div>
|
||
</body>
|
||
</html>
|