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

[boost][range] - Added documentation for the join() function. This is to resolve Trac ticket 4740.

Browse Source 
[SVN r67428]
This commit is contained in:
Neil Groves
2010-12-23 10:56:23 +00:00
parent c66fb8e807
commit 48fc316156
93 changed files with 543 additions and 494 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
doc/reference/utilities.qbk
View File

@ -271,25 +271,31 @@ The resultant range will have the lowest common traversal of the two ranges supp
Note that the joined range incurs a performance cost due to the need to check if the end of a range has been reached internally during traversal.
[h4 Synposis]
``
template<typename SinglePassRange1, typename SinglePassRange2>
iterator_range<range_detail::join_iterator<
typename range_iterator<const SinglePassRange1>::type,
typename range_iterator<const SinglePassRange2>::type,
typename add_const<
typename range_value<const SinglePassRange1>::type>::type>
>
joined_range<const SinglePassRange1, const SinglePassRange2>
join(const SinglePassRange1& rng1, const SinglePassRange2& rng2)
template<typename SinglePassRange1, typename SinglePassRange2>
iterator_range<range_detail::join_iterator<
typename range_iterator<SinglePassRange1>::type,
typename range_iterator<SinglePassRange2>::type,
typename range_value<SinglePassRange1>::type>
>
joined_range<SinglePassRange1, SinglePassRange2>
join(SinglePassRange1& rng1, SinglePassRange2& rng2);
``
For the const version:
* [*Precondition:] The `range_value<SinglePassRange2>::type` must be convertible to `range_value<SinglePassRange1>::type`. The `range_reference<const SinglePassRange2>::type` must be convertible to `range_reference<const SinglePassRange1>::type`.
* [*Range Category:] Both `rng1` and `rng2` must be a model of __single_pass_range__ or better.
* [*Range Return Type:] `joined_range<const SinglePassRange1, const SinglePassRange2>` which is a model of the lesser of the two range concepts passed.
* [*Returned Range Category:] The minimum of the range category of `rng1` and `rng2`.
For the mutable version:
* [*Precondition:] The `range_value<SinglePassRange2>::type` must be convertible to `range_value<SinglePassRange1>::type`. The `range_reference<SinglePassRange2>::type` must be convertible to `range_reference<SinglePassRange1>::type`.
* [*Range Category:] Both `rng1` and `rng2` must be a model of __single_pass_range__ or better.
* [*Range Return Type:] `joined_range<SinglePassRange1, SinglePassRange2>` which is a model of the lesser of the two range concepts passed.
* [*Returned Range Category:] The minimum of the range category of `rng1` and `rng2`.
[h4 Example]
The expression `join(irange(0,5), irange(5,10))` would evaluate to a range representing an integer range `[0,10)`