boostorg/fusion
1
0
Fork 1
mirror of https://github.com/boostorg/fusion.git synced 2025-07-29 20:17:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

fixing result of related fusion docs issues for fold, accumulate, and transform view/alg

Browse Source 
[SVN r39448]
This commit is contained in:
Dan Marsden
2007-09-21 15:44:57 +00:00
parent 6b56ded55a
commit 6344096709
2 changed files with 85 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

104
doc/algorithms.qbk
View File

@ -50,7 +50,7 @@ a sequence repeatedly applying an operation to its elements.
[section fold] [section fold]
[heading Description] [heading Description]
Repeatedly applies binary __poly_func_obj__ `f` to each element of a sequence and the previous state. For a sequence `Seq`, initial state, and binary function object or function pointer `f`, fold repeatedly applies binary `f` to each element of `Seq` and the previous state.
[heading Synopsis] [heading Synopsis]
template< template<
@ -63,9 +63,9 @@ Repeatedly applies binary __poly_func_obj__ `f` to each element of a sequence an
[table Parameters [table Parameters
[[Parameter][Requirement][Description]] [[Parameter][Requirement][Description]]
[[`seq`][A model of __forward_sequence__,`f(e)` must be a valid expression for each element `e` in `seq`][Operation's argument]] [[`seq`][A model of __forward_sequence__,`f(e,s)` must be a valid expression for each element `e` in `seq`, and current state `s`][Operation's argument]]
[[`initial_state`][Any type][Initial state]] [[`initial_state`][Any type][Initial state]]
[[`f`][A model of binary __poly_func_obj__][Operation's argument]] [[`f`][`__boost_result_of_call__<F(E,S)>::type` is the return type of `f(e,s)` for each element `e` of type `E` in `seq`, and current state `s` of type `S`][Operation's argument]]
] ]
[heading Expression Semantics] [heading Expression Semantics]
@ -84,11 +84,7 @@ Linear, exactly `__result_of_size__<Sequence>::value` applications of `f`.
[heading Example] [heading Example]
struct make_string struct make_string
{ {
template<typename T, typename State> typedef std::string result_type;
struct result
{
typedef std::string type;
};
template<typename T> template<typename T>
std::string operator()(const T& t, const std::string& str) const std::string operator()(const T& t, const std::string& str) const
@ -105,8 +101,7 @@ Linear, exactly `__result_of_size__<Sequence>::value` applications of `f`.
[section accumulate] [section accumulate]
[heading Description] [heading Description]
Repeatedly applies binary __poly_func_obj__ `f` to each element of a sequence and the previous state. For a sequence `Seq`, initial state, and binary function object or function pointer `f`, accumulate repeatedly applies binary `f` to each element of `Seq` and the previous state.
__accumulate__ is equivalent to __fold__.
[heading Synopsis] [heading Synopsis]
template< template<
@ -121,7 +116,7 @@ __accumulate__ is equivalent to __fold__.
[[Parameter][Requirement][Description]] [[Parameter][Requirement][Description]]
[[`seq`][A model of __forward_sequence__, `f(eN ....f(e2,f(e1,initial_state)))` must be a valid expression for each element `e1` to `eN` in `seq`][Operation's argument]] [[`seq`][A model of __forward_sequence__, `f(eN ....f(e2,f(e1,initial_state)))` must be a valid expression for each element `e1` to `eN` in `seq`][Operation's argument]]
[[`initial_state`][Any type][Initial state]] [[`initial_state`][Any type][Initial state]]
[[`f`][A model of binary __poly_func_obj__][Operation's argument]] [[`f`][`__boost_result_of_call__<F(E,S)>::type` is the return type of `f(e,s)` for each element `e` of type `E` in `seq`, and current state `s` of type `S`][Operation's argument]]
] ]
[heading Expression Semantics] [heading Expression Semantics]
@ -140,11 +135,7 @@ Linear, exactly `__result_of_size__<Sequence>::value` applications of `f`.
[heading Example] [heading Example]
struct make_string struct make_string
{ {
template<typename T, typename State> typedef std::string result_type;
struct result
{
typedef std::string type;
};
template<typename T> template<typename T>
std::string operator()(const T& t, const std::string& str) const std::string operator()(const T& t, const std::string& str) const
@ -229,7 +220,7 @@ Returns the result type of __fold__.
[[Parameter] [Requirement] [Description]] [[Parameter] [Requirement] [Description]]
[[`Sequence`] [A model of __forward_sequence__] [The sequence to iterate]] [[`Sequence`] [A model of __forward_sequence__] [The sequence to iterate]]
[[`State`] [Any type] [The initial state for the first application of `F`]] [[`State`] [Any type] [The initial state for the first application of `F`]]
[[`F`] [A model of binary __poly_func_obj__] [The operation to be applied on forward traversal]] [[`F`] [`__boost_result_of_call__<F(E,S)>::type` is the return type of `f(e,s)` for each element `e` of type `E` in `seq`, and current state `s` of type `S`] [The operation to be applied on forward traversal]]
] ]
[heading Expression Semantics] [heading Expression Semantics]
@ -238,7 +229,7 @@ Returns the result type of __fold__.
[*Return type]: Any type [*Return type]: Any type
[*Semantics]: Returns the result of applying `fold` to a sequence of type `Sequence`, with an initial state of [*Semantics]: Returns the result of applying `fold` to a sequence of type `Sequence`, with an initial state of
type `State` and binary __poly_func_obj__ of type `F`. type `State` and binary function object or function pointer of type `F`.
[heading Complexity] [heading Complexity]
Linear, exactly `__result_of_size__<Sequence>::value` applications of `F`. Linear, exactly `__result_of_size__<Sequence>::value` applications of `F`.
@ -267,7 +258,7 @@ Returns the result type of __accumulate__.
[[Parameter] [Requirement] [Description]] [[Parameter] [Requirement] [Description]]
[[`Sequence`] [A model of __forward_sequence__] [The sequence to iterate]] [[`Sequence`] [A model of __forward_sequence__] [The sequence to iterate]]
[[`State`] [Any type] [The initial state for the first application of `F`]] [[`State`] [Any type] [The initial state for the first application of `F`]]
[[`F`] [A model of binary __poly_func_obj__] [The operation to be applied on forward traversal]] [[`F`] [`__boost_result_of_call__<F(E,S)>::type` is the return type of `f(e,s)` for each element `e` of type `E` in `seq`, and current state `s` of type `S`] [The operation to be applied on forward traversal]]
] ]
[heading Expression Semantics] [heading Expression Semantics]
@ -276,7 +267,7 @@ Returns the result type of __accumulate__.
[*Return type]: Any type [*Return type]: Any type
[*Semantics]: Returns the result of applying `accumulate` to a sequence of type `Sequence`, with an initial state of [*Semantics]: Returns the result of applying `accumulate` to a sequence of type `Sequence`, with an initial state of
type `State` and binary __poly_func_obj__ of type `F`. type `State` and binary function object or function pointer of type `F`.
[heading Complexity] [heading Complexity]
Linear, exactly `__result_of_size__<Sequence>::value` applications of `F`. Linear, exactly `__result_of_size__<Sequence>::value` applications of `F`.
@ -997,8 +988,8 @@ Constant. Returns a view which is lazily evaluated.
[section transform] [section transform]
[heading Description] [heading Description]
For a sequence `seq` and __poly_func_obj__ `F`, `transform` returns a new sequence For a sequence `seq` and function object or function pointer `f`, `transform` returns a new sequence
with elements created by applying `F` to each element of `seq`. with elements created by applying `f(e)` to each element of `e` of `seq`.
[heading Unary version synopsis] [heading Unary version synopsis]
template< template<
@ -1011,7 +1002,7 @@ with elements created by applying `F` to each element of `seq`.
[table Parameters [table Parameters
[[Parameter][Requirement][Description]] [[Parameter][Requirement][Description]]
[[`seq`][A model of __forward_sequence__][Operation's argument]] [[`seq`][A model of __forward_sequence__][Operation's argument]]
[[`f`][A model of unary __poly_func_obj__ where `f(e)` is a valid expression for each element `e` of `seq`][Transformation function]] [[`f`][`f(e)` is a valid expression for each element `e` of `seq`. `__boost_result_of_call__<F(E)>::type` is the return type of `f` when called with a value of each element type `E`.][Transformation function]]
] ]
[heading Expression Semantics] [heading Expression Semantics]
@ -1034,7 +1025,7 @@ with elements created by applying `F` to each element of `seq`.
[[Parameter][Requirement][Description]] [[Parameter][Requirement][Description]]
[[`seq1`][A model of __forward_sequence__][Operation's argument]] [[`seq1`][A model of __forward_sequence__][Operation's argument]]
[[`seq2`][A model of __forward_sequence__][Operation's argument]] [[`seq2`][A model of __forward_sequence__][Operation's argument]]
[[`f`][A model of binary __poly_func_obj__ where `f(e1, e2)` is a valid expression for each pair of elements `e1` and `e2` of `seq1` and `seq2` respectively][Transformation function]] [[`f`][`f(e1,e2)` is a valid expression for each pair of elements `e1` of `seq1` and `e2` of `seq2`. `__boost_result_of_call__<F(E1,E2)>::type` is the return type of `f` when called with elements of type `E1` and `E2`][Transformation function]]
] ]
[*Return type]: A model of __forward_sequence__. [*Return type]: A model of __forward_sequence__.
@ -1050,14 +1041,9 @@ Constant. Returns a view which is lazily evaluated.
[heading Example] [heading Example]
struct triple struct triple
{ {
template<typename T> typedef int result_type;
struct result
{
typedef T type;
};
template<typename T> int operator()(int t) const
T operator()(T t) const
{ {
return t * 3; return t * 3;
}; };
@ -1774,37 +1760,69 @@ Constant.
[section transform] [section transform]
[heading Description] [heading Description]
Returns the result of type __transform__, given the sequence and __poly_func_obj__ types. For a sequence `seq` and function object or function pointer `f`, `transform` returns a new sequence
with elements created by applying `f(e)` to each element of `e` of `seq`.
[heading Synopsis] [heading Unary version synopsis]
template< template<
typename Sequence, typename Sequence,
typename F typename F
> >
struct transform typename __result_of_transform__<Sequence const, F>::type transform(
{ Sequence const& seq, F f);
typedef __unspecified__ type;
};
[table Parameters [table Parameters
[[Parameter] [Requirement] [Description]] [[Parameter][Requirement][Description]]
[[`Sequence`] [A model of __forward_sequence__ ][Operation's argument]] [[`seq`][A model of __forward_sequence__][Operation's argument]]
[[`F`] [A model of unary __poly_func_obj__][Transformation function object]] [[`f`][`f(e)` is a valid expression for each element `e` of `seq`. `__boost_result_of_call__<F(E)>::type` is the return type of `f` when called with a value of each element type `E`.][Transformation function]]
] ]
[heading Expression Semantics] [heading Expression Semantics]
__result_of_transform__<Sequence, F>::type __transform__(seq, f);
[*Return type]: A model of __forward_sequence__
[*Semantics]: Returns a new sequence, containing the return values of `f(e)` for each element `e` within `seq`.
[heading Binary version synopsis]
template<
typename Sequence1,
typename Sequence2,
typename F
>
typename __result_of_transform__<Sequence1 const, Sequence2 const, F>::type transform(
Sequence1 const& seq1, Sequence2 const& seq2, F f);
[table Parameters
[[Parameter][Requirement][Description]]
[[`seq1`][A model of __forward_sequence__][Operation's argument]]
[[`seq2`][A model of __forward_sequence__][Operation's argument]]
[[`f`][`f(e1,e2)` is a valid expression for each pair of elements `e1` of `seq1` and `e2` of `seq2`. `__boost_result_of_call__<F(E1,E2)>::type` is the return type of `f` when called with elements of type `E1` and `E2`][Transformation function]]
]
[*Return type]: A model of __forward_sequence__. [*Return type]: A model of __forward_sequence__.
[*Semantics]: Returns a sequence with values `F::result<E>::type` for each element type `E` in `Sequence`. [*Semantics]: Returns a new sequence, containing the return values of `f(e1, e2)` for each pair of elements `e1` and `e2` within `seq1` and `seq2` respectively.
[heading Complexity] [heading Complexity]
Constant. Constant. Returns a view which is lazily evaluated.
[heading Header] [heading Header]
#include <boost/fusion/algorithm/transformation/transform.hpp> #include <boost/fusion/algorithm/transformation/transform.hpp>
[heading Example]
struct triple
{
typedef int result_type;
int operator()(int t) const
{
return t * 3;
};
};
...
assert(__transform__(__make_vector__(1,2,3), triple()) == __make_vector__(3,6,9));
[endsect] [endsect]
[section replace] [section replace]

42
doc/sequences.qbk
View File

@ -1086,10 +1086,12 @@ defined in __forward_sequence__.
[section transform_view] [section transform_view]
`transform_view` presents a transformed view of its underlying sequence The unary version of `transform_view` presents a view of its underlying
given a unary __poly_func_obj__. The `transform_view` inherits the sequence given a unary function object or function pointer. The binary
traversal characteristics (see __traversal_concept__) of its underlying version of `transform_view` presents a view of 2 underlying sequences,
sequence. given a binary function object or function pointer. The `transform_view`
inherits the traversal characteristics (see __traversal_concept__) of
its underlying sequence or sequences.
[heading Header] [heading Header]
@ -1099,12 +1101,12 @@ sequence.
[*Unary Version] [*Unary Version]
template <typename Sequence, typename F> template <typename Sequence, typename F1>
struct transform_view; struct transform_view;
[*Binary Version] [*Binary Version]
template <typename Sequence1, typename Sequence2, typename F> template <typename Sequence1, typename Sequence2, typename F2>
struct transform_view; struct transform_view;
[heading Template parameters] [heading Template parameters]
@ -1114,7 +1116,8 @@ sequence.
[[`Sequence`] [A __forward_sequence__] []] [[`Sequence`] [A __forward_sequence__] []]
[[`Sequence1`] [A __forward_sequence__] []] [[`Sequence1`] [A __forward_sequence__] []]
[[`Sequence2`] [A __forward_sequence__] []] [[`Sequence2`] [A __forward_sequence__] []]
[[`F`] [A __poly_func_obj__] []] [[`F1`] [A unary function object or function pointer. `__boost_result_of_call__<F1(E)>::type` is the return type of an instance of `F1` when called with a value of each element type `E` in the input sequence.] []]
[[`F2`] [A binary function object or function pointer. `__boost_result_of_call__<F2(E1, E2)>::type` is the return type of an instance of `F2` when called with a value of each corresponding pair of element type `E1` and `E2` in the input sequences.] []]
] ]
[heading Model of] [heading Model of]
@ -1127,7 +1130,8 @@ __traversal_concept__) of its underlying sequence.
[[`TV`] [A `transform_view` type]] [[`TV`] [A `transform_view` type]]
[[`BTV`] [A binary `transform_view` type]] [[`BTV`] [A binary `transform_view` type]]
[[`UTV`] [A unary `transform_view` type]] [[`UTV`] [A unary `transform_view` type]]
[[`f`] [An instance of `F`]] [[`f1`] [An instance of `F1`]]
[[`f2`] [An instance of `F2`]]
[[`s`] [An instance of `Sequence`]] [[`s`] [An instance of `Sequence`]]
[[`s1`] [An instance of `Sequence1`]] [[`s1`] [An instance of `Sequence1`]]
[[`s2`] [An instance of `Sequence2`]] [[`s2`] [An instance of `Sequence2`]]
@ -1139,14 +1143,14 @@ __traversal_concept__) of its underlying sequence.
Semantics of an expression is defined only where it differs from, or is not Semantics of an expression is defined only where it differs from, or is not
defined in __forward_sequence__, __bidirectional_sequence__ or defined in __forward_sequence__, __bidirectional_sequence__ or
__random_access_sequence__ depending on the traversal characteristics (see __random_access_sequence__ depending on the traversal characteristics (see
__traversal_concept__) of its underlying sequence. __traversal_concept__) of its underlying sequence or sequences.
[table [table
[[Expression] [Semantics]] [[Expression] [Semantics]]
[[`UTV(s, f)`] [Creates a unary `transform_view` given sequence, [[`UTV(s, f1)`] [Creates a unary `transform_view` given sequence,
`s` and unary __poly_func_obj__, `f`.]] `s` and unary function object or function pointer, `f1`.]]
[[`BTV(s1, s2, f)`] [Creates a binary `transform_view` given sequences, `s1` and `s2` [[`BTV(s1, s2, f2)`] [Creates a binary `transform_view` given sequences, `s1` and `s2`
and unary __poly_func_obj__, `f`.]] and binary function object or function pointer, `f2`.]]
[[`TV(tv)`] [Copy constructs a `transform_view` from another `transform_view`, `tv`.]] [[`TV(tv)`] [Copy constructs a `transform_view` from another `transform_view`, `tv`.]]
[[`tv = tv2`] [Assigns to a `transform_view`, `tv`, from another `transform_view`, `tv2`.]] [[`tv = tv2`] [Assigns to a `transform_view`, `tv`, from another `transform_view`, `tv2`.]]
] ]
@ -1155,11 +1159,13 @@ __traversal_concept__) of its underlying sequence.
struct square struct square
{ {
template <typename T> template<typename Sig>
struct result struct result;
{
typedef T type; template<typename U>
}; struct result<square(U)>
: remove_reference<U>
{};
template <typename T> template <typename T>
T operator()(T x) const T operator()(T x) const