From 13d00bd6c2ab9a56c1c1c2e6416408f22876296d Mon Sep 17 00:00:00 2001 From: Michael Caisse Date: Wed, 22 May 2013 23:28:12 +0000 Subject: [PATCH] minor updates to fusion docs [SVN r84440] --- doc/html/index.html | 289 +++++++++++++++++++++++++++++++++++++++++--- doc/sequence.qbk | 74 +++++++----- 2 files changed, 316 insertions(+), 47 deletions(-) diff --git a/doc/html/index.html b/doc/html/index.html index eba1b61e..bba8e552 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -1,16 +1,277 @@ - - - - Redirect to generated documentation - - - - Automatic redirection failed, please go to - http://boost-sandbox.sourceforge.net/libs/fusion/doc/html/ - + + +Chapter 1. Fusion 2.2 + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
Next
+
+
+

+Chapter 1. Fusion 2.2

+

+Joel de Guzman +

+

+Dan Marsden +

+

+Tobias Schwinger +

+

Copyright © 2001-2006, 2011, 2012 Joel de Guzman, + Dan Marsden, Tobias Schwinger

+
+

+ 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) +

+
+
+
+

Table of Contents

+
+
Preface
+
Introduction
+
Quick Start
+
Organization
+
Support
+
+
is_sequence
+
is_view
+
tag_of
+
category_of
+
deduce
+
deduce_sequence
+
pair
+
+
Iterator
+
+
Concepts
+
+
Forward + Iterator
+
Bidirectional + Iterator
+
Random + Access Iterator
+
Associative + Iterator
+
+
Functions
+
+
deref
+
next
+
prior
+
distance
+
advance
+
advance_c
+
deref_data
+
+
Operator
+
+
Operator + *
+
Operator + ==
+
Operator + !=
+
+
Metafunctions
+
+
value_of
+
deref
+
next
+
prior
+
equal_to
+
distance
+
advance
+
advance_c
+
key_of
+
value_of_data
+
deref_data
+
+
+
Sequence
+
+
Concepts
+
+
Forward + Sequence
+
Bidirectional + Sequence
+
Random + Access Sequence
+
Associative + Sequence
+
+
Intrinsic
+
+
Functions
+
Metafunctions
+
+
Operator
+
+
I/O
+
Comparison
+
+
+
Container
+
+
vector
+
cons
+
list
+
deque
+
front_extended_deque
+
back_extended_deque
+
set
+
map
+
Generation
+
+
Functions
+
MetaFunctions
+
+
Conversion
+
+
Functions
+
Metafunctions
+
+
+
View
+
+
single_view
+
filter_view
+
iterator_range
+
joint_view
+
zip_view
+
transform_view
+
reverse_view
+
nview
+
repetitive_view
+
+
Adapted
+
+
Array
+
std::pair
+
mpl sequence
+
boost::array
+
boost::tuple
+
BOOST_FUSION_ADAPT_STRUCT
+
BOOST_FUSION_ADAPT_TPL_STRUCT
+
BOOST_FUSION_ADAPT_STRUCT_NAMED
+
BOOST_FUSION_ADAPT_ASSOC_STRUCT
+
BOOST_FUSION_ADAPT_ASSOC_TPL_STRUCT
+
BOOST_FUSION_ADAPT_ASSOC_STRUCT_NAMED
+
BOOST_FUSION_ADAPT_ADT
+
BOOST_FUSION_ADAPT_TPL_ADT
+
BOOST_FUSION_ADAPT_ASSOC_ADT
+
BOOST_FUSION_ADAPT_ASSOC_TPL_ADT
+
BOOST_FUSION_DEFINE_STRUCT
+
BOOST_FUSION_DEFINE_TPL_STRUCT
+
BOOST_FUSION_DEFINE_STRUCT_INLINE
+
BOOST_FUSION_DEFINE_TPL_STRUCT_INLINE
+
BOOST_FUSION_DEFINE_ASSOC_STRUCT
+
BOOST_FUSION_DEFINE_ASSOC_TPL_STRUCT
+
+
Algorithm
+
+
Auxiliary
+
Functions
+
Iteration
+
+
Functions
+
Metafunctions
+
+
Query
+
+
Functions
+
Metafunctions
+
+
Transformation
+
+
Functions
+
Metafunctions
+
+
+
Tuple
+
+
Class template tuple
+
+
Construction
+
Tuple + creation functions
+
Tuple + helper classes
+
Element + access
+
Relational + operators
+
+
Pairs
+
+
Extension
+
+
The Full Extension Mechanism
+
Sequence Facade
+
Iterator Facade
+
+
Functional
+
+
Concepts
+
+
Callable Object
+
Regular Callable + Object
+
Deferred Callable + Object
+
Polymorphic Function + Object
+
+
Invocation
+
+
Functions
+
Metafunctions
+
Limits
+
+
Adapters
+
+
fused
+
fused_procedure
+
fused_function_object
+
unfused
+
unfused_typed
+
Limits
+
+
Generation
+
+
Functions
+
Metafunctions
+
+
+
Notes
+
Change log
+
Acknowledgements
+
References
+
+
+
+ + + +

Last revised: May 10, 2013 at 05:54:18 GMT

+
+
Next
+ diff --git a/doc/sequence.qbk b/doc/sequence.qbk index 633ad5ea..9e27f1c8 100644 --- a/doc/sequence.qbk +++ b/doc/sequence.qbk @@ -142,8 +142,8 @@ __bidirectional_iterator__. __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 @@ __bidirectional_sequence__ [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 @@ any Random Access Sequence the following must be met: [[Expression] [Return type] [Type Requirements] [Runtime Complexity]] [[`__begin__(s)`] [__random_access_iterator__] [] [Constant]] [[`__end__(s)`] [__random_access_iterator__] [] [Constant]] - [[`__at__(s)`] [Any type] [] [Constant]] - [[`__at__(s) = o`] [Any type] [`s` is mutable and + [[`__at_c__(s)`] [Any type] [] [Constant]] + [[`__at_c__(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__(s)`] [Any type] [] [Constant]] + [[`__at__(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 @@ are not defined in __bidirectional_sequence__. [table [[Expression] [Semantics]] - [[`__at__(s)`] [The Nth element from the beginning of the sequence; see __at__.]] + [[`__at__(s)`] [The Mth element from the beginning of the sequence; see __at__.]] + [[`__at_c__(s)`] [The Nth element from the beginning of the sequence; see __at_c__.]] ] [heading Models] @@ -643,15 +651,15 @@ in the sequence. [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 + template typename __result_of_at__::type at(Sequence& seq); - template + template typename __result_of_at__::type at(Sequence const& seq); @@ -660,25 +668,25 @@ Returns the N-th element from the beginning of the sequence. [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(seq); + at(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__(__begin__(s))) + __deref__(__advance__(__begin__(s))) [heading Header] @@ -1116,7 +1124,7 @@ the actual element type, use __result_of_value_at__]. [heading Synopsis] template< typename Seq, - typename N> + typename M> struct at { typedef __unspecified__ type; @@ -1125,15 +1133,15 @@ the actual element type, use __result_of_value_at__]. [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::type + result_of::at::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 @@ get the actual element type, use __result_of_value_at_c__]. [heading Synopsis] template< typename Seq, - int M> + int N> struct at_c { typedef __unspecified__ type; @@ -1167,15 +1175,15 @@ get the actual element type, use __result_of_value_at_c__]. [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::type + result_of::at_c::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 @@ Returns the actual type at a given index from the __sequence__. [heading Synopsis] template< typename Seq, - typename N> + typename M> struct value_at { typedef __unspecified__ type; @@ -1206,15 +1214,15 @@ Returns the actual type at a given index from the __sequence__. [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::type + result_of::value_at::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 @@ Returns the actual type at a given index from the __sequence__. [heading Synopsis] template< typename Seq, - int M> + int N> struct value_at_c { typedef __unspecified__ type; @@ -1245,15 +1253,15 @@ Returns the actual type at a given index from the __sequence__. [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::type + result_of::value_at_c::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]