Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r84440 - in trunk/libs/fusion/doc: . html
From: mcaisse_at_[hidden]
Date: 2013-05-22 19:28:12

Author: mjcaisse
Date: 2013-05-22 19:28:12 EDT (Wed, 22 May 2013)
New Revision: 84440
URL: http://svn.boost.org/trac/boost/changeset/84440

Log:
minor updates to fusion docs
Text files modified:
   trunk/libs/fusion/doc/html/index.html | 289 ++++++++++++++++++++++++++++++++++++++-
   trunk/libs/fusion/doc/sequence.qbk | 74 +++++----
   2 files changed, 316 insertions(+), 47 deletions(-)

Modified: trunk/libs/fusion/doc/html/index.html
==============================================================================
--- trunk/libs/fusion/doc/html/index.html (original)
+++ trunk/libs/fusion/doc/html/index.html 2013-05-22 19:28:12 EDT (Wed, 22 May 2013)
@@ -1,16 +1,277 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
- <head>
- 
- <title>Redirect to generated documentation</title>
- <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/libs/fusion/doc/html/">
- </head>
- <body>
- Automatic redirection failed, please go to
- http://boost-sandbox.sourceforge.net/libs/fusion/doc/html/
- </body>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Chapter 1. Fusion 2.2</title>
+<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
+<link rel="home" href="index.html" title="Chapter 1. Fusion 2.2">
+<link rel="next" href="fusion/preface.html" title="Preface">
+</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">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav"><a accesskey="n" href="fusion/preface.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a></div>
+<div class="chapter">
+<div class="titlepage"><div>
+<div><h2 class="title">
+<a name="fusion"></a>Chapter 1. Fusion 2.2</h2></div>
+<div><div class="author"><h3 class="author">
+Joel de Guzman
+</h3></div></div>
+<div><div class="author"><h3 class="author">
+Dan Marsden
+</h3></div></div>
+<div><div class="author"><h3 class="author">
+Tobias Schwinger
+</h3></div></div>
+<div>Copyright © 2001-2006, 2011, 2012 Joel de Guzman,
+ Dan Marsden, Tobias Schwinger</div>
+<div><div class="legalnotice">
+<a name="fusion.legal"></a>
+ Distributed under the Boost Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></div>
+</div></div>
+<div class="toc">
+Table of Contents
+<dl>
+<dt>Preface</dt>
+<dt>Introduction</dt>
+<dt>Quick Start</dt>
+<dt>Organization</dt>
+<dt>Support</dt>
+<dd><dl>
+<dt>is_sequence</dt>
+<dt>is_view</dt>
+<dt>tag_of</dt>
+<dt>category_of</dt>
+<dt>deduce</dt>
+<dt>deduce_sequence</dt>
+<dt>pair</dt>
+</dl></dd>
+<dt>Iterator</dt>
+<dd><dl>
+<dt>Concepts</dt>
+<dd><dl>
+<dt><a href="fusion/iterator/concepts/forward_iterator.html">Forward
+ Iterator</a></dt>
+<dt><a href="fusion/iterator/concepts/bidirectional_iterator.html">Bidirectional
+ Iterator</a></dt>
+<dt><a href="fusion/iterator/concepts/random_access_iterator.html">Random
+ Access Iterator</a></dt>
+<dt><a href="fusion/iterator/concepts/associative_iterator.html">Associative
+ Iterator</a></dt>
+</dl></dd>
+<dt>Functions</dt>
+<dd><dl>
+<dt>deref</dt>
+<dt>next</dt>
+<dt>prior</dt>
+<dt>distance</dt>
+<dt>advance</dt>
+<dt>advance_c</dt>
+<dt>deref_data</dt>
+</dl></dd>
+<dt>Operator</dt>
+<dd><dl>
+<dt><a href="fusion/iterator/operator/operator_unary_star.html">Operator
+ *</a></dt>
+<dt><a href="fusion/iterator/operator/operator_equality.html">Operator
+ ==</a></dt>
+<dt><a href="fusion/iterator/operator/operator_inequality.html">Operator
+ !=</a></dt>
+</dl></dd>
+<dt>Metafunctions</dt>
+<dd><dl>
+<dt>value_of</dt>
+<dt>deref</dt>
+<dt>next</dt>
+<dt>prior</dt>
+<dt>equal_to</dt>
+<dt>distance</dt>
+<dt>advance</dt>
+<dt>advance_c</dt>
+<dt>key_of</dt>
+<dt>value_of_data</dt>
+<dt>deref_data</dt>
+</dl></dd>
+</dl></dd>
+<dt>Sequence</dt>
+<dd><dl>
+<dt>Concepts</dt>
+<dd><dl>
+<dt><a href="fusion/sequence/concepts/forward_sequence.html">Forward
+ Sequence</a></dt>
+<dt><a href="fusion/sequence/concepts/bidirectional_sequence.html">Bidirectional
+ Sequence</a></dt>
+<dt><a href="fusion/sequence/concepts/random_access_sequence.html">Random
+ Access Sequence</a></dt>
+<dt><a href="fusion/sequence/concepts/associative_sequence.html">Associative
+ Sequence</a></dt>
+</dl></dd>
+<dt>Intrinsic</dt>
+<dd><dl>
+<dt>Functions</dt>
+<dt>Metafunctions</dt>
+</dl></dd>
+<dt>Operator</dt>
+<dd><dl>
+<dt>I/O</dt>
+<dt>Comparison</dt>
+</dl></dd>
+</dl></dd>
+<dt>Container</dt>
+<dd><dl>
+<dt>vector</dt>
+<dt>cons</dt>
+<dt>list</dt>
+<dt>deque</dt>
+<dt>front_extended_deque</dt>
+<dt>back_extended_deque</dt>
+<dt>set</dt>
+<dt>map</dt>
+<dt>Generation</dt>
+<dd><dl>
+<dt>Functions</dt>
+<dt>MetaFunctions</dt>
+</dl></dd>
+<dt>Conversion</dt>
+<dd><dl>
+<dt>Functions</dt>
+<dt>Metafunctions</dt>
+</dl></dd>
+</dl></dd>
+<dt>View</dt>
+<dd><dl>
+<dt>single_view</dt>
+<dt>filter_view</dt>
+<dt>iterator_range</dt>
+<dt>joint_view</dt>
+<dt>zip_view</dt>
+<dt>transform_view</dt>
+<dt>reverse_view</dt>
+<dt>nview</dt>
+<dt>repetitive_view</dt>
+</dl></dd>
+<dt>Adapted</dt>
+<dd><dl>
+<dt>Array</dt>
+<dt>std::pair</dt>
+<dt>mpl sequence</dt>
+<dt>boost::array</dt>
+<dt>boost::tuple</dt>
+<dt>BOOST_FUSION_ADAPT_STRUCT</dt>
+<dt>BOOST_FUSION_ADAPT_TPL_STRUCT</dt>
+<dt>BOOST_FUSION_ADAPT_STRUCT_NAMED</dt>
+<dt>BOOST_FUSION_ADAPT_ASSOC_STRUCT</dt>
+<dt>BOOST_FUSION_ADAPT_ASSOC_TPL_STRUCT</dt>
+<dt>BOOST_FUSION_ADAPT_ASSOC_STRUCT_NAMED</dt>
+<dt>BOOST_FUSION_ADAPT_ADT</dt>
+<dt>BOOST_FUSION_ADAPT_TPL_ADT</dt>
+<dt>BOOST_FUSION_ADAPT_ASSOC_ADT</dt>
+<dt>BOOST_FUSION_ADAPT_ASSOC_TPL_ADT</dt>
+<dt>BOOST_FUSION_DEFINE_STRUCT</dt>
+<dt>BOOST_FUSION_DEFINE_TPL_STRUCT</dt>
+<dt>BOOST_FUSION_DEFINE_STRUCT_INLINE</dt>
+<dt>BOOST_FUSION_DEFINE_TPL_STRUCT_INLINE</dt>
+<dt>BOOST_FUSION_DEFINE_ASSOC_STRUCT</dt>
+<dt>BOOST_FUSION_DEFINE_ASSOC_TPL_STRUCT</dt>
+</dl></dd>
+<dt>Algorithm</dt>
+<dd><dl>
+<dt>Auxiliary</dt>
+<dd><dl><dt>Functions</dt></dl></dd>
+<dt>Iteration</dt>
+<dd><dl>
+<dt>Functions</dt>
+<dt>Metafunctions</dt>
+</dl></dd>
+<dt>Query</dt>
+<dd><dl>
+<dt>Functions</dt>
+<dt>Metafunctions</dt>
+</dl></dd>
+<dt>Transformation</dt>
+<dd><dl>
+<dt>Functions</dt>
+<dt>Metafunctions</dt>
+</dl></dd>
+</dl></dd>
+<dt>Tuple</dt>
+<dd><dl>
+<dt>Class template tuple</dt>
+<dd><dl>
+<dt>Construction</dt>
+<dt><a href="fusion/tuple/class_template_tuple/tuple_creation_functions.html">Tuple
+ creation functions</a></dt>
+<dt><a href="fusion/tuple/class_template_tuple/tuple_helper_classes.html">Tuple
+ helper classes</a></dt>
+<dt><a href="fusion/tuple/class_template_tuple/element_access.html">Element
+ access</a></dt>
+<dt><a href="fusion/tuple/class_template_tuple/relational_operators.html">Relational
+ operators</a></dt>
+</dl></dd>
+<dt>Pairs</dt>
+</dl></dd>
+<dt>Extension</dt>
+<dd><dl>
+<dt>The Full Extension Mechanism</dt>
+<dt>Sequence Facade</dt>
+<dt>Iterator Facade</dt>
+</dl></dd>
+<dt>Functional</dt>
+<dd><dl>
+<dt>Concepts</dt>
+<dd><dl>
+<dt>Callable Object</dt>
+<dt><a href="fusion/functional/concepts/reg_callable.html">Regular Callable
+ Object</a></dt>
+<dt><a href="fusion/functional/concepts/def_callable.html">Deferred Callable
+ Object</a></dt>
+<dt><a href="fusion/functional/concepts/poly.html">Polymorphic Function
+ Object</a></dt>
+</dl></dd>
+<dt>Invocation</dt>
+<dd><dl>
+<dt>Functions</dt>
+<dt>Metafunctions</dt>
+<dt>Limits</dt>
+</dl></dd>
+<dt>Adapters</dt>
+<dd><dl>
+<dt>fused</dt>
+<dt>fused_procedure</dt>
+<dt>fused_function_object</dt>
+<dt>unfused</dt>
+<dt>unfused_typed</dt>
+<dt>Limits</dt>
+</dl></dd>
+<dt>Generation</dt>
+<dd><dl>
+<dt>Functions</dt>
+<dt>Metafunctions</dt>
+</dl></dd>
+</dl></dd>
+<dt>Notes</dt>
+<dt>Change log</dt>
+<dt>Acknowledgements</dt>
+<dt>References</dt>
+</dl>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left">Last revised: May 10, 2013 at 05:54:18 GMT</td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav"><a accesskey="n" href="fusion/preface.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a></div>
+</body>
</html>

Modified: trunk/libs/fusion/doc/sequence.qbk
==============================================================================
--- trunk/libs/fusion/doc/sequence.qbk (original)
+++ trunk/libs/fusion/doc/sequence.qbk 2013-05-22 19:28:12 EDT (Wed, 22 May 2013)
@@ -142,8 +142,8 @@
__forward_sequence__

[variablelist Notation
- [[`s`] [A Forward Sequence]]
- [[`S`] [A Forward Sequence type]]
+ [[`s`] [A Bidirectional Sequence]]
+ [[`S`] [A Bidirectional Sequence type]]
 [[`o`] [An arbitrary object]]
 [[`e`] [A Sequence element]]
]
@@ -213,7 +213,8 @@
[variablelist Notation
 [[`s`] [A Random Access Sequence]]
 [[`S`] [A Random Access Sequence type]]
- [[`N`] [An __mpl_integral_constant__]]
+ [[`M`] [An __mpl__ integral constant]]
+ [[`N`] [An integral constant]]
 [[`o`] [An arbitrary object]]
 [[`e`] [A Sequence element]]
]
@@ -227,12 +228,18 @@
 [[Expression] [Return type] [Type Requirements] [Runtime Complexity]]
 [[`__begin__(s)`] [__random_access_iterator__] [] [Constant]]
 [[`__end__(s)`] [__random_access_iterator__] [] [Constant]]
- [[`__at__<N>(s)`] [Any type] [] [Constant]]
- [[`__at__<N>(s) = o`] [Any type] [`s` is mutable and
+ [[`__at_c__<N>(s)`] [Any type] [] [Constant]]
+ [[`__at_c__<N>(s) = o`] [Any type] [`s` is mutable and
 `e = o`, where `e`
 is the first element
 in the sequence, is
- a valid expression.] [Constant]]
+ a valid expression.] [Constant]]
+ [[`__at__<M>(s)`] [Any type] [] [Constant]]
+ [[`__at__<M>(s) = o`] [Any type] [`s` is mutable and
+ `e = o`, where `e`
+ is the first element
+ in the sequence, is
+ a valid expression.] [Constant]]
]

[heading Result Type Expressions]
@@ -258,7 +265,8 @@

[table
 [[Expression] [Semantics]]
- [[`__at__<N>(s)`] [The Nth element from the beginning of the sequence; see __at__.]]
+ [[`__at__<M>(s)`] [The Mth element from the beginning of the sequence; see __at__.]]
+ [[`__at_c__<N>(s)`] [The Nth element from the beginning of the sequence; see __at_c__.]]
]

[heading Models]
@@ -643,15 +651,15 @@

[heading Description]

-Returns the N-th element from the beginning of the sequence.
+Returns the M-th element from the beginning of the sequence.

[heading Synopsis]

- template <typename N, typename Sequence>
+ template <typename M, typename Sequence>
 typename __result_of_at__<Sequence, N>::type
 at(Sequence& seq);

- template <typename N, typename Sequence>
+ template <typename M, typename Sequence>
 typename __result_of_at__<Sequence const, N>::type
 at(Sequence const& seq);

@@ -660,25 +668,25 @@
[table
 [[Parameter] [Requirement] [Description]]
 [[`seq`] [Model of __random_access_sequence__] [The sequence we wish to investigate.]]
- [[`N`] [An __mpl_integral_constant__] [An index from the beginning of the
+ [[`M`] [An __mpl_integral_constant__] [An index from the beginning of the
 sequence.]]
]

[heading Expression Semantics]

- at<N>(seq);
+ at<M>(seq);

-[*Return type]: Returns a reference to the N-th element from the beginning
-of the sequence `seq` if `seq` is mutable and `e = o`, where `e` is the N-th
+[*Return type]: Returns a reference to the M-th element from the beginning
+of the sequence `seq` if `seq` is mutable and `e = o`, where `e` is the M-th
element from the beginning of the sequence, is a valid expression. Else,
-returns a type convertable to the N-th element from the beginning of the
+returns a type convertable to the M-th element from the beginning of the
sequence.

-[*Precondition]: `0 <= N::value < __size__(s)`
+[*Precondition]: `0 <= M::value < __size__(s)`

[*Semantics]: Equivalent to

- __deref__(__advance__<N>(__begin__(s)))
+ __deref__(__advance__<M>(__begin__(s)))

[heading Header]

@@ -1116,7 +1124,7 @@
[heading Synopsis]
 template<
 typename Seq,
- typename N>
+ typename M>
 struct at
 {
 typedef __unspecified__ type;
@@ -1125,15 +1133,15 @@
[table Parameters
 [[Parameter] [Requirement] [Description]]
 [[`Seq`][A model of __random_access_sequence__][Argument sequence]]
- [[`N`][An __mpl_integral_constant__][Index of element]]
+ [[`M`][An __mpl_integral_constant__][Index of element]]
]

[heading Expression Semantics]
- result_of::at<Seq, N>::type
+ result_of::at<Seq, M>::type

[*Return type]: Any type.

-[*Semantics]: Returns the result type of using __at__ to access the `N`th element of `Seq`.
+[*Semantics]: Returns the result type of using __at__ to access the `M`th element of `Seq`.

[heading Header]

@@ -1158,7 +1166,7 @@
[heading Synopsis]
 template<
 typename Seq,
- int M>
+ int N>
 struct at_c
 {
 typedef __unspecified__ type;
@@ -1167,15 +1175,15 @@
[table Parameters
 [[Parameter] [Requirement] [Description]]
 [[`Seq`][A model of __random_access_sequence__][Argument sequence]]
- [[`M`][Positive integer index][Index of element]]
+ [[`N`][Positive integer index][Index of element]]
]

[heading Expression Semantics]
- result_of::at_c<Seq, M>::type
+ result_of::at_c<Seq, N>::type

[*Return type]: Any type

-[*Semantics]: Returns the result type of using __at_c__ to access the `M`th element of `Seq`.
+[*Semantics]: Returns the result type of using __at_c__ to access the `N`th element of `Seq`.

[heading Header]

@@ -1197,7 +1205,7 @@
[heading Synopsis]
 template<
 typename Seq,
- typename N>
+ typename M>
 struct value_at
 {
 typedef __unspecified__ type;
@@ -1206,15 +1214,15 @@
[table Parameters
 [[Parameter] [Requirement] [Description]]
 [[`Seq`][A model of __random_access_sequence__][Argument sequence]]
- [[`N`][An __mpl_integral_constant__][Index of element]]
+ [[`M`][An __mpl_integral_constant__][Index of element]]
]

[heading Expression Semantics]
- result_of::value_at<Seq, N>::type
+ result_of::value_at<Seq, M>::type

[*Return type]: Any type.

-[*Semantics]: Returns the actual type at the `N`th element of `Seq`.
+[*Semantics]: Returns the actual type at the `M`th element of `Seq`.

[heading Header]

@@ -1236,7 +1244,7 @@
[heading Synopsis]
 template<
 typename Seq,
- int M>
+ int N>
 struct value_at_c
 {
 typedef __unspecified__ type;
@@ -1245,15 +1253,15 @@
[table Parameters
 [[Parameter] [Requirement] [Description]]
 [[`Seq`][A model of __random_access_sequence__][Argument sequence]]
- [[`M`][Positive integer index][Index of element]]
+ [[`N`][Positive integer index][Index of element]]
]

[heading Expression Semantics]
- result_of::value_at_c<Seq, M>::type
+ result_of::value_at_c<Seq, N>::type

[*Return type]: Any type

-[*Semantics]: Returns the actual type at the `M`th element of `Seq`.
+[*Semantics]: Returns the actual type at the `N`th element of `Seq`.

[heading Header]

Date view	Thread view	Subject view	Author view

Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk