Regenerate fusion documentation.

[SVN r41607]
This commit is contained in:
Daniel James committed 2007-12-03 00:09:20 +00:00
1 parent df69f05f94
commit 59df6ee7f1
259 files changed
+7187 -7506

No files matched your search

@@ -1,24 +1,21 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title> Operator
==</title>
<title>Operator ==</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.72.0">
<link rel="start" href="../../../index.html" title="Chapter 1. Fusion 2.0">
<link rel="up" href="../operator.html" title="Operator">
<link rel="prev" href="operator_unary_star.html" title=" Operator
*">
<link rel="next" href="operator_inequality.html" title=" Operator
!=">
<link rel="prev" href="operator_unary_star.html" title="Operator *">
<link rel="next" href="operator_inequality.html" title="Operator !=">
</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="../../../../../../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://beta.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://beta.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
@@ -27,20 +24,20 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="fusion.iterator.operator.operator_equality"></a><a href="operator_equality.html" title=" Operator
=="> Operator
==</a></h4></div></div></div>
<a name="fusion.iterator.operator.operator_equality.description"></a><h5>
<a name="id479437"></a>
<a name="fusion.iterator.operator.operator_equality"></a><a href="operator_equality.html" title="Operator =="> Operator
==</a>
</h4></div></div></div>
<a name="fusion.iterator.operator.operator_equality.description"></a><h6>
<a name="id2634829"></a>
<a href="operator_equality.html#fusion.iterator.operator.operator_equality.description">Description</a>
</h5>
</h6>
<p>
Compares 2 iterators for equality.
</p>
<a name="fusion.iterator.operator.operator_equality.synopsis"></a><h5>
<a name="id479468"></a>
<a name="fusion.iterator.operator.operator_equality.synopsis"></a><h6>
<a name="id2634856"></a>
<a href="operator_equality.html#fusion.iterator.operator.operator_equality.synopsis">Synopsis</a>
</h5>
</h6>
<pre class="programlisting">
<span class="keyword">template</span><span class="special">&lt;</span>
<span class="keyword">typename</span> <span class="identifier">I</span><span class="special">,</span>
@@ -49,8 +46,8 @@
<span class="emphasis"><em>unspecified</em></span> <span class="keyword">operator</span><span class="special">==(</span><span class="identifier">I</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">i</span><span class="special">,</span> <span class="identifier">J</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">i</span><span class="special">);</span>
</pre>
<div class="table">
<a name="id479610"></a><p class="title"><b>Table 1.9. Parameters</b></p>
<table class="table" summary="Parameters">
<a name="id2634983"></a><p class="title"><b>Table 1.9. Parameters</b></p>
<div class="table-contents"><table class="table" summary="Parameters">
<colgroup>
<col>
<col>
@@ -76,7 +73,7 @@
<tbody><tr>
<td>
<p>
<tt class="computeroutput"><span class="identifier">i</span></tt>, <tt class="computeroutput"><span class="identifier">j</span></tt>
<code class="computeroutput"><span class="identifier">i</span></code>, <code class="computeroutput"><span class="identifier">j</span></code>
</p>
</td>
<td>
@@ -90,23 +87,23 @@
</p>
</td>
</tr></tbody>
</table>
</table></div>
</div>
<a name="fusion.iterator.operator.operator_equality.expression_semantics"></a><h5>
<a name="id479714"></a>
<br class="table-break"><a name="fusion.iterator.operator.operator_equality.expression_semantics"></a><h6>
<a name="id2635077"></a>
<a href="operator_equality.html#fusion.iterator.operator.operator_equality.expression_semantics">Expression
Semantics</a>
</h5>
</h6>
<pre class="programlisting">
<span class="identifier">i</span> <span class="special">==</span> <span class="identifier">j</span>
</pre>
<p>
<span class="bold"><b>Return type</b></span>: Convertible to <tt class="computeroutput"><span class="keyword">bool</span></tt>.
<span class="bold"><strong>Return type</strong></span>: Convertible to <code class="computeroutput"><span class="keyword">bool</span></code>.
</p>
<p>
<span class="bold"><b>Semantics</b></span>: Equivalent to <tt class="computeroutput"><a href="../metafunctions/equal_to.html" title="equal_to"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">equal_to</span></tt></a><span class="special">&lt;</span><span class="identifier">I</span><span class="special">,</span><span class="identifier">J</span><span class="special">&gt;::</span><span class="identifier">value</span></tt>
where <tt class="computeroutput"><span class="identifier">I</span></tt> and <tt class="computeroutput"><span class="identifier">J</span></tt> are the types of <tt class="computeroutput"><span class="identifier">i</span></tt>
and <tt class="computeroutput"><span class="identifier">j</span></tt> respectively.
<span class="bold"><strong>Semantics</strong></span>: Equivalent to <code class="computeroutput"><a href="../metafunctions/equal_to.html" title="equal_to"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">equal_to</span></code></a><span class="special">&lt;</span><span class="identifier">I</span><span class="special">,</span><span class="identifier">J</span><span class="special">&gt;::</span><span class="identifier">value</span></code>
where <code class="computeroutput"><span class="identifier">I</span></code> and <code class="computeroutput"><span class="identifier">J</span></code> are the types of <code class="computeroutput"><span class="identifier">i</span></code>
and <code class="computeroutput"><span class="identifier">j</span></code> respectively.
</p>
<p>
/iterator/equal_to.hpp&gt;
@@ -1,14 +1,12 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title> Operator
!=</title>
<title>Operator !=</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.72.0">
<link rel="start" href="../../../index.html" title="Chapter 1. Fusion 2.0">
<link rel="up" href="../operator.html" title="Operator">
<link rel="prev" href="operator_equality.html" title=" Operator
==">
<link rel="prev" href="operator_equality.html" title="Operator ==">
<link rel="next" href="../metafunctions.html" title="Metafunctions">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -16,8 +14,8 @@
<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="http://beta.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://beta.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
@@ -26,20 +24,20 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="fusion.iterator.operator.operator_inequality"></a><a href="operator_inequality.html" title=" Operator
!="> Operator
!=</a></h4></div></div></div>
<a name="fusion.iterator.operator.operator_inequality.description"></a><h5>
<a name="id479932"></a>
<a name="fusion.iterator.operator.operator_inequality"></a><a href="operator_inequality.html" title="Operator !="> Operator
!=</a>
</h4></div></div></div>
<a name="fusion.iterator.operator.operator_inequality.description"></a><h6>
<a name="id2635274"></a>
<a href="operator_inequality.html#fusion.iterator.operator.operator_inequality.description">Description</a>
</h5>
</h6>
<p>
Compares 2 iterators for inequality.
</p>
<a name="fusion.iterator.operator.operator_inequality.synopsis"></a><h5>
<a name="id479964"></a>
<a name="fusion.iterator.operator.operator_inequality.synopsis"></a><h6>
<a name="id2635301"></a>
<a href="operator_inequality.html#fusion.iterator.operator.operator_inequality.synopsis">Synopsis</a>
</h5>
</h6>
<pre class="programlisting">
<span class="keyword">template</span><span class="special">&lt;</span>
<span class="keyword">typename</span> <span class="identifier">I</span><span class="special">,</span>
@@ -48,8 +46,8 @@
<span class="emphasis"><em>unspecified</em></span> <span class="keyword">operator</span><span class="special">==(</span><span class="identifier">I</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">i</span><span class="special">,</span> <span class="identifier">J</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">i</span><span class="special">);</span>
</pre>
<div class="table">
<a name="id480108"></a><p class="title"><b>Table 1.10. Parameters</b></p>
<table class="table" summary="Parameters">
<a name="id2635429"></a><p class="title"><b>Table 1.10. Parameters</b></p>
<div class="table-contents"><table class="table" summary="Parameters">
<colgroup>
<col>
<col>
@@ -75,7 +73,7 @@
<tbody><tr>
<td>
<p>
<tt class="computeroutput"><span class="identifier">i</span></tt>, <tt class="computeroutput"><span class="identifier">j</span></tt>
<code class="computeroutput"><span class="identifier">i</span></code>, <code class="computeroutput"><span class="identifier">j</span></code>
</p>
</td>
<td>
@@ -89,20 +87,20 @@
</p>
</td>
</tr></tbody>
</table>
</table></div>
</div>
<a name="fusion.iterator.operator.operator_inequality.expression_semantics"></a><h5>
<a name="id480213"></a>
<br class="table-break"><a name="fusion.iterator.operator.operator_inequality.expression_semantics"></a><h6>
<a name="id2635523"></a>
<a href="operator_inequality.html#fusion.iterator.operator.operator_inequality.expression_semantics">Expression
Semantics</a>
</h5>
</h6>
<p>
<span class="bold"><b>Return type</b></span>: Convertible to <tt class="computeroutput"><span class="keyword">bool</span></tt>.
<span class="bold"><strong>Return type</strong></span>: Convertible to <code class="computeroutput"><span class="keyword">bool</span></code>.
</p>
<p>
<span class="bold"><b>Semantics</b></span>: Equivalent to <tt class="computeroutput"><span class="special">!</span><a href="../metafunctions/equal_to.html" title="equal_to"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">equal_to</span></tt></a><span class="special">&lt;</span><span class="identifier">I</span><span class="special">,</span><span class="identifier">J</span><span class="special">&gt;::</span><span class="identifier">value</span></tt>
where <tt class="computeroutput"><span class="identifier">I</span></tt> and <tt class="computeroutput"><span class="identifier">J</span></tt> are the types of <tt class="computeroutput"><span class="identifier">i</span></tt>
and <tt class="computeroutput"><span class="identifier">j</span></tt> respectively.
<span class="bold"><strong>Semantics</strong></span>: Equivalent to <code class="computeroutput"><span class="special">!</span><a href="../metafunctions/equal_to.html" title="equal_to"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">equal_to</span></code></a><span class="special">&lt;</span><span class="identifier">I</span><span class="special">,</span><span class="identifier">J</span><span class="special">&gt;::</span><span class="identifier">value</span></code>
where <code class="computeroutput"><span class="identifier">I</span></code> and <code class="computeroutput"><span class="identifier">J</span></code> are the types of <code class="computeroutput"><span class="identifier">i</span></code>
and <code class="computeroutput"><span class="identifier">j</span></code> respectively.
</p>
<p>
/iterator/equal_to.hpp&gt;
@@ -1,23 +1,21 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title> Operator
*</title>
<title>Operator *</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.72.0">
<link rel="start" href="../../../index.html" title="Chapter 1. Fusion 2.0">
<link rel="up" href="../operator.html" title="Operator">
<link rel="prev" href="../operator.html" title="Operator">
<link rel="next" href="operator_equality.html" title=" Operator
==">
<link rel="next" href="operator_equality.html" title="Operator ==">
</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="../../../../../../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://beta.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://beta.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
@@ -26,29 +24,29 @@
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h4 class="title">
<a name="fusion.iterator.operator.operator_unary_star"></a><a href="operator_unary_star.html" title=" Operator
*"> Operator
*</a></h4></div></div></div>
<a name="fusion.iterator.operator.operator_unary_star.description"></a><h5>
<a name="id478608"></a>
<a name="fusion.iterator.operator.operator_unary_star"></a><a href="operator_unary_star.html" title="Operator *"> Operator
*</a>
</h4></div></div></div>
<a name="fusion.iterator.operator.operator_unary_star.description"></a><h6>
<a name="id2634088"></a>
<a href="operator_unary_star.html#fusion.iterator.operator.operator_unary_star.description">Description</a>
</h5>
</h6>
<p>
Dereferences an iterator.
</p>
<a name="fusion.iterator.operator.operator_unary_star.synopsis"></a><h5>
<a name="id478639"></a>
<a name="fusion.iterator.operator.operator_unary_star.synopsis"></a><h6>
<a name="id2634115"></a>
<a href="operator_unary_star.html#fusion.iterator.operator.operator_unary_star.synopsis">Synopsis</a>
</h5>
</h6>
<pre class="programlisting">
<span class="keyword">template</span><span class="special">&lt;</span>
<span class="keyword">typename</span> <span class="identifier">I</span>
<span class="special">&gt;</span>
<span class="keyword">typename</span> <a href="../metafunctions/deref.html" title="deref"><tt class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">deref</span></tt></a><span class="special">&lt;</span><span class="identifier">I</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="keyword">operator</span><span class="special">*(</span><span class="emphasis"><em>unspecified</em></span><span class="special">&lt;</span><span class="identifier">I</span><span class="special">&gt;</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">i</span><span class="special">);</span>
<span class="keyword">typename</span> <a href="../metafunctions/deref.html" title="deref"><code class="computeroutput"><span class="identifier">result_of</span><span class="special">::</span><span class="identifier">deref</span></code></a><span class="special">&lt;</span><span class="identifier">I</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="keyword">operator</span><span class="special">*(</span><span class="emphasis"><em>unspecified</em></span><span class="special">&lt;</span><span class="identifier">I</span><span class="special">&gt;</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">i</span><span class="special">);</span>
</pre>
<div class="table">
<a name="id478798"></a><p class="title"><b>Table 1.8. Parameters</b></p>
<table class="table" summary="Parameters">
<a name="id2634258"></a><p class="title"><b>Table 1.8. Parameters</b></p>
<div class="table-contents"><table class="table" summary="Parameters">
<colgroup>
<col>
<col>
@@ -74,13 +72,12 @@
<tbody><tr>
<td>
<p>
<tt class="computeroutput"><span class="identifier">i</span></tt>
<code class="computeroutput"><span class="identifier">i</span></code>
</p>
</td>
<td>
<p>
Model of <a href="../concepts/forward_iterator.html" title="Forward
Iterator">Forward
Model of <a href="../concepts/forward_iterator.html" title="Forward Iterator">Forward
Iterator</a>
</p>
</td>
@@ -90,38 +87,38 @@
</p>
</td>
</tr></tbody>
</table>
</table></div>
</div>
<a name="fusion.iterator.operator.operator_unary_star.expression_semantics"></a><h5>
<a name="id478900"></a>
<br class="table-break"><a name="fusion.iterator.operator.operator_unary_star.expression_semantics"></a><h6>
<a name="id2634350"></a>
<a href="operator_unary_star.html#fusion.iterator.operator.operator_unary_star.expression_semantics">Expression
Semantics</a>
</h5>
</h6>
<pre class="programlisting">
<span class="special">*</span><span class="identifier">i</span>
</pre>
<p>
<span class="bold"><b>Return type</b></span>: Equivalent to the return
type of <tt class="computeroutput"><a href="../functions/deref.html" title="deref"><tt class="computeroutput"><span class="identifier">deref</span></tt></a><span class="special">(</span><span class="identifier">i</span><span class="special">)</span></tt>.
<span class="bold"><strong>Return type</strong></span>: Equivalent to the return
type of <code class="computeroutput"><a href="../functions/deref.html" title="deref"><code class="computeroutput"><span class="identifier">deref</span></code></a><span class="special">(</span><span class="identifier">i</span><span class="special">)</span></code>.
</p>
<p>
<span class="bold"><b>Semantics</b></span>: Equivalent to <tt class="computeroutput"><a href="../functions/deref.html" title="deref"><tt class="computeroutput"><span class="identifier">deref</span></tt></a><span class="special">(</span><span class="identifier">i</span><span class="special">)</span></tt>.
<span class="bold"><strong>Semantics</strong></span>: Equivalent to <code class="computeroutput"><a href="../functions/deref.html" title="deref"><code class="computeroutput"><span class="identifier">deref</span></code></a><span class="special">(</span><span class="identifier">i</span><span class="special">)</span></code>.
</p>
<p>
/iterator/deref.hpp&gt;
</p>
<a name="fusion.iterator.operator.operator_unary_star.example"></a><h5>
<a name="id479046"></a>
<a name="fusion.iterator.operator.operator_unary_star.example"></a><h6>
<a name="id2634478"></a>
<a href="operator_unary_star.html#fusion.iterator.operator.operator_unary_star.example">Example</a>
</h5>
</h6>
<pre class="programlisting">
<span class="keyword">typedef</span> <a href="../../container/vector.html" title="vector"><tt class="computeroutput"><span class="identifier">vector</span></tt></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span><span class="keyword">int</span><span class="special">&amp;&gt;</span> <span class="identifier">vec</span><span class="special">;</span>
<span class="keyword">typedef</span> <a href="../../container/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">&amp;&gt;</span> <span class="identifier">vec</span><span class="special">;</span>
<span class="keyword">int</span> <span class="identifier">i</span><span class="special">(</span><span class="number">0</span><span class="special">);</span>
<span class="identifier">vec</span> <span class="identifier">v</span><span class="special">(</span><span class="number">1</span><span class="special">,</span><span class="identifier">i</span><span class="special">);</span>
<span class="identifier">assert</span><span class="special">(*</span><a href="../../sequence/intrinsic/functions/begin.html" title="begin"><tt class="computeroutput"><span class="identifier">begin</span></tt></a><span class="special">(</span><span class="identifier">v</span><span class="special">)</span> <span class="special">==</span> <span class="number">1</span><span class="special">);</span>
<span class="identifier">assert</span><span class="special">(*</span><a href="../functions/next.html" title="next"><tt class="computeroutput"><span class="identifier">next</span></tt></a><span class="special">(</span><a href="../../sequence/intrinsic/functions/begin.html" title="begin"><tt class="computeroutput"><span class="identifier">begin</span></tt></a><span class="special">(</span><span class="identifier">v</span><span class="special">))</span> <span class="special">==</span> <span class="number">0</span><span class="special">);</span>
<span class="identifier">assert</span><span class="special">(&amp;(*</span><a href="../functions/next.html" title="next"><tt class="computeroutput"><span class="identifier">next</span></tt></a><span class="special">(</span><a href="../../sequence/intrinsic/functions/begin.html" title="begin"><tt class="computeroutput"><span class="identifier">begin</span></tt></a><span class="special">(</span><span class="identifier">v</span><span class="special">)))</span> <span class="special">==</span> <span class="special">&amp;</span><span class="identifier">i</span><span class="special">);</span>
<span class="identifier">assert</span><span class="special">(*</span><a href="../../sequence/intrinsic/functions/begin.html" title="begin"><code class="computeroutput"><span class="identifier">begin</span></code></a><span class="special">(</span><span class="identifier">v</span><span class="special">)</span> <span class="special">==</span> <span class="number">1</span><span class="special">);</span>
<span class="identifier">assert</span><span class="special">(*</span><a href="../functions/next.html" title="next"><code class="computeroutput"><span class="identifier">next</span></code></a><span class="special">(</span><a href="../../sequence/intrinsic/functions/begin.html" title="begin"><code class="computeroutput"><span class="identifier">begin</span></code></a><span class="special">(</span><span class="identifier">v</span><span class="special">))</span> <span class="special">==</span> <span class="number">0</span><span class="special">);</span>
<span class="identifier">assert</span><span class="special">(&amp;(*</span><a href="../functions/next.html" title="next"><code class="computeroutput"><span class="identifier">next</span></code></a><span class="special">(</span><a href="../../sequence/intrinsic/functions/begin.html" title="begin"><code class="computeroutput"><span class="identifier">begin</span></code></a><span class="special">(</span><span class="identifier">v</span><span class="special">)))</span> <span class="special">==</span> <span class="special">&amp;</span><span class="identifier">i</span><span class="special">);</span>
</pre>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>