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

Document repetitive_view. Fixes #1864.

Browse Source 
[SVN r63219]
This commit is contained in:
Steven Watanabe
2010-06-22 04:17:12 +00:00
parent f26c90729a
commit c57b658e79
1 changed files with 66 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
doc/view.qbk
View File

@ -548,4 +548,70 @@ of the original Fusion __sequence__
[endsect]
[section repetitive_view]
[heading Description]
`repetitive_view` presents a view which iterates over a given
__sequence__ repeatedly. Because a `repetitive_view`
has infinite length, it can only be used when some external
condition determines the end. Thus, initializing a fixed
length sequence with a `repetitive_view` is okay, but
printing a `repetitive_view` to `std::cout` is not.
[heading Header]
#include <boost/fusion/view/repetitive_view.hpp>
#include <boost/fusion/include/repetitive_view.hpp>
[heading Synopsis]
template <typename Sequence>
struct repetitive_view;
[heading Template parameters]
[table
[[Parameter] [Description] [Default]]
[[`Sequence`] [An arbitrary Fusion __forward_sequence__]
[]]
]
[variablelist Notation
[[`RV`] [A `repetitive_view` type]]
[[`s`] [An instance of `Sequences`]]
[[`rv`, `rv1`, `rv2`] [Instances of `RV`]]
]
[heading Expression Semantics]
[table
[[Expression] [Return Type] [Semantics]]
[[`RV(s)`] [] [Creates an `repetitive_view` given a sequence and a list of indicies.]]
[[`RV(rv1)`] [] [Copy constructs an `repetitive_view` from another `repetitive_view`, `rv1`.]]
[[`rv1 = rv2`] [] [Assigns to a `repetitive_view`, `rv1`, from another `repetitive_view`, `rv2`.]]
[[`__begin__(rv)`] [__forward_iterator__] []]
[[`__end__(rv)`] [__forward_iterator__] [Creates an unreachable iterator (since the sequnce is infinite)]]
]
[heading Result Type Expressions]
[table
[[Expression]]
[[`__result_of_begin__<RV>::type`]]
[[`__result_of_end__<RV>::type`]]
]
[heading Example]
typedef __vector__<int, char, double> vec1;
typedef __vector__<int, char, double, int, char> vec2;
vec1 v1(1, 'c', 2.0);
vec2 v2(repetitive_view<vec1>(v1));
std::cout << v2 << std::endl; // 1, 'c', 2.0, 1, 'c'
[endsect]
[endsect]