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

Doc updates for deque

Browse Source 
[SVN r78199]
This commit is contained in:
Joel de Guzman
2012-04-26 00:03:42 +00:00
parent 524769f6fb
commit 66e8a6d3b7
1 changed files with 91 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

122
doc/container.qbk
View File

@ -1372,49 +1372,29 @@ rules for __element_conversion__.
Returns the result type of __make_deque__.
[heading C++03 Synopsis]
template <typename T0, typename T1,... typename TN>
struct make_deque;
The variadic function accepts `0` to `FUSION_MAX_DEQUE_SIZE` elements, where
`FUSION_MAX_DEQUE_SIZE` is a user definable predefined maximum that defaults
to `10`. You may define the preprocessor constant `FUSION_MAX_DEQUE_SIZE`
before including any Fusion header to change the default. Example:
#define FUSION_MAX_DEQUE_SIZE 20
[heading C++03 Parameters]
[table
[[Parameter] [Requirement] [Description]]
[[`T0, T1,... TN`] [Any type] [Template arguments to `make_deque`]]
]
[heading C++03 Expression Semantics]
result_of::make_deque<T0, T1,... TN>::type
[*Return type]: A __deque__ with elements of types converted following the
rules for __element_conversion__.
[*Semantics]: Create a __deque__ from `T0, T1,... TN`.
[heading C++11 Synopsis]
[heading Synopsis]
template <typename ...Elements>
struct make_deque;
For C++11 compilers, the variadic template interface has no upper bound.
[heading C++11 Parameters]
For C++03 The variadic function accepts `0` to `FUSION_MAX_DEQUE_SIZE`
elements, where `FUSION_MAX_DEQUE_SIZE` is a user definable predefined
maximum that defaults to `10`. You may define the preprocessor constant
`FUSION_MAX_DEQUE_SIZE` before including any Fusion header to change the
default. Example:
#define FUSION_MAX_DEQUE_SIZE 20
[heading Parameters]
[table
[[Parameter] [Requirement] [Description]]
[[`Elements`] [Variadic template types] [Template arguments to `make_deque`]]
]
[heading C++11 Expression Semantics]
[heading Expression Semantics]
result_of::make_deque<Elements...>::type
@ -1821,6 +1801,48 @@ Convert a fusion sequence to a __vector__.
[endsect]
[section as_deque]
[heading Description]
Convert a fusion sequence to a __deque__.
[heading Synopsis]
template <typename Sequence>
typename result_of::as_deque<Sequence>::type
as_deque(Sequence& seq);
template <typename Sequence>
typename result_of::as_deque<Sequence const>::type
as_deque(Sequence const& seq);
[heading Parameters]
[table
[[Parameter] [Requirement] [Description]]
[[`seq`] [An instance of Sequence] [The sequence to convert.]]
]
[heading Expression Semantics]
as_deque(seq);
[*Return type]: __result_of_as_deque__`<Sequence>::type`
[*Semantics]: Convert a fusion sequence, `seq`, to a __deque__.
[heading Header]
#include <boost/fusion/container/deque/convert.hpp>
#include <boost/fusion/include/as_deque.hpp>
[heading Example]
as_deque(__make_vector__('x', 123, "hello"))
[endsect]
[section as_set]
[heading Description]
@ -1992,6 +2014,44 @@ Returns the result type of __as_vector__.
[endsect]
[section as_deque]
[heading Description]
Returns the result type of __as_deque__.
[heading Synopsis]
template <typename Sequence>
struct as_deque;
[heading Parameters]
[table
[[Parameter] [Requirement] [Description]]
[[`Sequence`] [A fusion __sequence__] [The sequence type to convert.]]
]
[heading Expression Semantics]
result_of::as_deque<Sequence>::type;
[*Return type]: A __deque__ with same elements as the input sequence,
`Sequence`.
[*Semantics]: Convert a fusion sequence, `Sequence`, to a __deque__.
[heading Header]
#include <boost/fusion/container/deque/convert.hpp>
#include <boost/fusion/include/as_deque.hpp>
[heading Example]
result_of::as_deque<__vector__<char, int> >::type
[endsect]
[section as_set]
[heading Description]