feedc0de/boost_fusion
1
0
Fork 0
forked from boostorg/fusion
Code Pull Requests Activity
Files
74d062d2da7bb1a4e6e1a6f2577209b4d17d0b51
boost_fusion/doc/html/fusion/functional/adapters/fused.html
Tobias Schwinger ca6f831b96 adds documentation for functional module 
[SVN r36959]
2007-02-15 23:11:24 +00:00

204 lines
12 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>fused</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="../adapters.html" title=" Adapters">
<link rel="prev" href="../adapters.html" title=" Adapters">
<link rel="next" href="fused_procedure.html" title="fused_procedure">
</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="../adapters.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../adapters.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="fused_procedure.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.adapters.fused"></a><a href="fused.html" title="fused">fused</a></h4></div></div></div>
<a name="fusion.functional.adapters.fused.description"></a><h5>
<a name="id1209486"></a>
<a href="fused.html#fusion.functional.adapters.fused.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/def_callable.html" title=" Deferred
Callable Object">Deferred
Callable Object</a> target functions. It takes a <a href="../../sequences/concepts/forward_sequence.html" title="Forward
Sequence">Forward
Sequence</a> that contains the arguments for the target function.
</p>
<p>
The nested <code class="computeroutput"><span class="identifier">result</span></code> metafunction
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 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 <code class="literal">operator()</code> can be used
for an 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 <code class="literal">this</code>, 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 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.adapters.fused.header"></a><h5>
<a name="id1209629"></a>
<a href="fused.html#fusion.functional.adapters.fused.header">Header</a>
</h5>
<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">adapter</span><span class="special">/</span><span class="identifier">fused</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.functional.adapters.fused.synopsis"></a><h5>
<a name="id1209720"></a>
<a href="fused.html#fusion.functional.adapters.fused.synopsis">Synopsis</a>
</h5>
<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">&gt;</span>
<span class="keyword">class</span> <span class="identifier">fused</span><span class="special">;</span>
</pre>
<a name="fusion.functional.adapters.fused.template_parameters"></a><h5>
<a name="id1209789"></a>
<a href="fused.html#fusion.functional.adapters.fused.template_parameters">Template
parameters</a>
</h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>Parameter</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody><tr>
<td><code class="computeroutput"><span class="identifier">Function</span></code></td>
<td>A
<a href="../concepts/def_callable.html" title=" Deferred
Callable Object">Deferred
Callable Object</a>
</td>
<td> </td>
</tr></tbody>
</table></div>
<a name="fusion.functional.adapters.fused.model_of"></a><h5>
<a name="id1209865"></a>
<a href="fused.html#fusion.functional.adapters.fused.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"><code class="computeroutput"><span class="identifier">R</span></code></span></dt>
<dd>
A possibly const qualified <a href="../concepts/def_callable.html" title=" Deferred
Callable Object">Deferred
Callable Object</a> type or reference type thereof
</dd>
<dt><span class="term"><code class="computeroutput"><span class="identifier">r</span></code></span></dt>
<dd>
An object convertible to <code class="computeroutput"><span class="identifier">R</span></code>
</dd>
<dt><span class="term"><code class="computeroutput"><span class="identifier">s</span></code></span></dt>
<dd>
A <a href="../../sequences.html" title="Sequences">Sequence</a> of arguments that
are accepted by <code class="computeroutput"><span class="identifier">r</span></code>
</dd>
<dt><span class="term"><code class="computeroutput"><span class="identifier">f</span></code></span></dt>
<dd>
An instance of <code class="computeroutput"><span class="identifier">fused</span><span class="special">&lt;</span><span class="identifier">R</span><span class="special">&gt;</span></code>
</dd>
</dl>
</div>
<a name="fusion.functional.adapters.fused.expression_semantics"></a><h5>
<a name="id1210037"></a>
<a href="fused.html#fusion.functional.adapters.fused.expression_semantics">Expression
Semantics</a>
</h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>Expression</th>
<th>Semantics</th>
</tr></thead>
<tbody>
<tr>
<td><code class="computeroutput"><span class="identifier">fused</span><span class="special">&lt;</span><span class="identifier">R</span><span class="special">&gt;(</span><span class="identifier">r</span><span class="special">)</span></code></td>
<td>Creates
a fused function as described above, initializes the target function
with <code class="computeroutput"><span class="identifier">r</span></code>.</td>
</tr>
<tr>
<td><code class="computeroutput"><span class="identifier">fused</span><span class="special">&lt;</span><span class="identifier">R</span><span class="special">&gt;()</span></code></td>
<td>Creates
a fused function as described above, attempts to use <code class="computeroutput"><span class="identifier">R</span></code>'s default constructor.</td>
</tr>
<tr>
<td><code class="computeroutput"><span class="identifier">f</span><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></code></td>
<td>Calls
<code class="computeroutput"><span class="identifier">r</span></code> with the elements
in <code class="computeroutput"><span class="identifier">s</span></code> as its arguments.</td>
</tr>
</tbody>
</table></div>
<a name="fusion.functional.adapters.fused.example"></a><h5>
<a name="id1210219"></a>
<a href="fused.html#fusion.functional.adapters.fused.example">Example</a>
</h5>
<pre class="programlisting">
<span class="identifier">fused</span><span class="special">&lt;</span> <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">long</span><span class="special">&gt;</span> <span class="special">&gt;</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><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">2l</span><span class="special">))</span> <span class="special">==</span> <span class="number">3l</span><span class="special">);</span>
</pre>
<a name="fusion.functional.adapters.fused.see_also"></a><h5>
<a name="id1210375"></a>
<a href="fused.html#fusion.functional.adapters.fused.see_also">See also</a>
</h5>
<div class="itemizedlist"><ul type="disc">
<li><a href="fused_procedure.html" title="fused_procedure"><code class="computeroutput"><span class="identifier">fused_procedure</span></code></a></li>
<li><a href="fused_function_object.html" title="fused_function_object"><code class="computeroutput"><span class="identifier">fused_function_object</span></code></a></li>
<li><a href="../invocation/functions/invoke.html" title="invoke"><code class="computeroutput"><span class="identifier">invoke</span></code></a></li>
<li><a href="../../support/deduce.html" title="deduce"><code class="computeroutput"><span class="identifier">deduce</span></code></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"><small>Copyright © 2001-2005 Joel de Guzman, Dan Marsden</small></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../adapters.html"><img src="../../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../adapters.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="fused_procedure.html"><img src="../../../images/next.png" alt="Next"></a>
</div>
</body>
</html>
View Git Blame Copy Permalink