feedc0de/boost_fusion
1
0
Fork 0
forked from boostorg/fusion
Code Pull Requests Activity

Rebuild a lot of documentation.

Browse Source 
[SVN r43650]
This commit is contained in:
Daniel James
2008-03-16 11:38:32 +00:00
parent 9e8d8b1871
commit 813930aee6
257 changed files with 8717 additions and 9036 deletions
Download Patch File Download Diff File Expand all files Collapse all files

146
doc/html/fusion/functional/adapters/fused.html
View File

@ -3,19 +3,19 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>fused</title>
<link rel="stylesheet" href="../../../../../../../doc/html/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.66.1">
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="../../../index.html" title="Chapter<65>1.<2E>Fusion 2.0">
<link rel="up" href="../adapters.html" title=" Adapters">
<link rel="prev" href="../adapters.html" title=" Adapters">
<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%"><tr>
<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="../../../../../../../index.html">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="http://www.boost.org/people/people.htm">People</a></td>
<td align="center"><a href="http://www.boost.org/more/faq.htm">FAQ</a></td>
<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
@ -24,53 +24,51 @@
</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="id661998"></a>
<a href="fused.html#fusion.functional.adapters.fused.description">Description</a>
</h5>
<a name="fusion.functional.adapters.fused"></a><a class="link" href="fused.html" title="fused">fused</a>
</h4></div></div></div>
<a name="fusion.functional.adapters.fused.description"></a><h6>
<a name="id2819284"></a>
<a class="link" href="fused.html#fusion.functional.adapters.fused.description">Description</a>
</h6>
<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="../../sequence/concepts/forward_sequence.html" title="Forward
Sequence">Forward
An unary <a class="link" href="../concepts/poly.html" title="Polymorphic Function Object">Polymorphic Function
Object</a> adapter template for <a class="link" href="../concepts/def_callable.html" title="Deferred Callable Object">Deferred
Callable Object</a> target functions. It takes a <a class="link" href="../../sequence/concepts/forward_sequence.html" title="Forward Sequence">Forward
Sequence</a> that contains the arguments for the target function.
</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
words, only const versions of <code class="literal">operator()</code> 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
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 <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>).
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>
/functional/adapter/fused.hpp&gt;
</p>
<a name="fusion.functional.adapters.fused.synopsis"></a><h5>
<a name="id662134"></a>
<a href="fused.html#fusion.functional.adapters.fused.synopsis">Synopsis</a>
</h5>
<a name="fusion.functional.adapters.fused.synopsis"></a><h6>
<a name="id2819407"></a>
<a class="link" href="fused.html#fusion.functional.adapters.fused.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">&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="id662214"></a>
<a href="fused.html#fusion.functional.adapters.fused.template_parameters">Template
<a name="fusion.functional.adapters.fused.template_parameters"></a><h6>
<a name="id2819477"></a>
<a class="link" href="fused.html#fusion.functional.adapters.fused.template_parameters">Template
parameters</a>
</h5>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
@ -97,13 +95,12 @@
<tbody><tr>
<td>
<p>
<tt class="computeroutput"><span class="identifier">Function</span></tt>
<code class="computeroutput"><span class="identifier">Function</span></code>
</p>
</td>
<td>
<p>
A <a href="../concepts/def_callable.html" title=" Deferred
Callable Object">Deferred
A <a class="link" href="../concepts/def_callable.html" title="Deferred Callable Object">Deferred
Callable Object</a>
</p>
</td>
@ -113,47 +110,44 @@
</td>
</tr></tbody>
</table></div>
<a name="fusion.functional.adapters.fused.model_of"></a><h5>
<a name="id662329"></a>
<a href="fused.html#fusion.functional.adapters.fused.model_of">Model of</a>
</h5>
<a name="fusion.functional.adapters.fused.model_of"></a><h6>
<a name="id2819578"></a>
<a class="link" href="fused.html#fusion.functional.adapters.fused.model_of">Model of</a>
</h6>
<div class="itemizedlist"><ul type="disc">
<li><a href="../concepts/poly.html" title=" Polymorphic Function
Object">Polymorphic Function
<li><a class="link" 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
<li><a class="link" 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>
<dt><span class="term"><code class="computeroutput"><span class="identifier">R</span></code></span></dt>
<dd><p>
A possibly const qualified <a href="../concepts/def_callable.html" title=" Deferred
Callable Object">Deferred
A possibly const qualified <a class="link" href="../concepts/def_callable.html" title="Deferred Callable Object">Deferred
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>
<dt><span class="term"><code class="computeroutput"><span class="identifier">r</span></code></span></dt>
<dd><p>
An object convertible to <tt class="computeroutput"><span class="identifier">R</span></tt>
An object convertible to <code class="computeroutput"><span class="identifier">R</span></code>
</p></dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">s</span></tt></span></dt>
<dt><span class="term"><code class="computeroutput"><span class="identifier">s</span></code></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>
A <a class="link" href="../../sequence.html" title="Sequence">Sequence</a> of arguments that
are accepted by <code class="computeroutput"><span class="identifier">r</span></code>
</p></dd>
<dt><span class="term"><tt class="computeroutput"><span class="identifier">f</span></tt></span></dt>
<dt><span class="term"><code class="computeroutput"><span class="identifier">f</span></code></span></dt>
<dd><p>
An instance of <tt class="computeroutput"><span class="identifier">fused</span><span class="special">&lt;</span><span class="identifier">R</span><span class="special">&gt;</span></tt>
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>
</p></dd>
</dl>
</div>
<a name="fusion.functional.adapters.fused.expression_semantics"></a><h5>
<a name="id662549"></a>
<a href="fused.html#fusion.functional.adapters.fused.expression_semantics">Expression
<a name="fusion.functional.adapters.fused.expression_semantics"></a><h6>
<a name="id2819777"></a>
<a class="link" href="fused.html#fusion.functional.adapters.fused.expression_semantics">Expression
Semantics</a>
</h5>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
@ -175,61 +169,61 @@
<tr>
<td>
<p>
<tt 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></tt>
<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>
</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>.
function with <code class="computeroutput"><span class="identifier">r</span></code>.
</p>
</td>
</tr>
<tr>
<td>
<p>
<tt class="computeroutput"><span class="identifier">fused</span><span class="special">&lt;</span><span class="identifier">R</span><span class="special">&gt;()</span></tt>
<code class="computeroutput"><span class="identifier">fused</span><span class="special">&lt;</span><span class="identifier">R</span><span class="special">&gt;()</span></code>
</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.
Creates a fused function as described above, attempts to use <code class="computeroutput"><span class="identifier">R</span></code>'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>
<code class="computeroutput"><span class="identifier">f</span><span class="special">(</span><span class="identifier">s</span><span class="special">)</span></code>
</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
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.
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="fusion.functional.adapters.fused.example"></a><h5>
<a name="id662804"></a>
<a href="fused.html#fusion.functional.adapters.fused.example">Example</a>
</h5>
<a name="fusion.functional.adapters.fused.example"></a><h6>
<a name="id2820006"></a>
<a class="link" href="fused.html#fusion.functional.adapters.fused.example">Example</a>
</h6>
<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"><tt class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">plus</span></tt></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="../../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">2l</span><span class="special">))</span> <span class="special">==</span> <span class="number">3l</span><span class="special">);</span>
<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 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">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="id662981"></a>
<a href="fused.html#fusion.functional.adapters.fused.see_also">See also</a>
</h5>
<a name="fusion.functional.adapters.fused.see_also"></a><h6>
<a name="id2820165"></a>
<a class="link" href="fused.html#fusion.functional.adapters.fused.see_also">See also</a>
</h6>
<div class="itemizedlist"><ul type="disc">
<li><a href="fused_procedure.html" title="fused_procedure"><tt class="computeroutput"><span class="identifier">fused_procedure</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.html" title="invoke"><tt class="computeroutput"><span class="identifier">invoke</span></tt></a></li>
<li><a href="../../support/deduce.html" title="deduce"><tt class="computeroutput"><span class="identifier">deduce</span></tt></a></li>
<li><a class="link" href="fused_procedure.html" title="fused_procedure"><code class="computeroutput"><span class="identifier">fused_procedure</span></code></a></li>
<li><a class="link" href="fused_function_object.html" title="fused_function_object"><code class="computeroutput"><span class="identifier">fused_function_object</span></code></a></li>
<li><a class="link" href="../invocation/functions/invoke.html" title="invoke"><code class="computeroutput"><span class="identifier">invoke</span></code></a></li>
<li><a class="link" 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>