mirror of
https://github.com/boostorg/range.git
synced 2025-07-29 12:27:42 +02:00
[range] fixed some doc typos (patch by Michel Morin)
[SVN r81889]
This commit is contained in:
@ -20,7 +20,7 @@ Special thanks goes to
|
||||
* Pavel Vozenilek for help with porting the library
|
||||
* Jonathan Turkanis and John Torjo for help with documentation
|
||||
* Hartmut Kaiser for being review manager
|
||||
* Jonathan Turkanis for porting the lib (as far sa possible) to vc6 and vc7.
|
||||
* Jonathan Turkanis for porting the lib (as far as possible) to vc6 and vc7.
|
||||
|
||||
The concept checks and their documentation was provided by Daniel Walker.
|
||||
|
||||
|
@ -147,7 +147,7 @@
|
||||
</p>
|
||||
</div>
|
||||
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
|
||||
<td align="left"><p><small>Last revised: December 13, 2012 at 06:35:02 GMT</small></p></td>
|
||||
<td align="left"><p><small>Last revised: December 13, 2012 at 06:53:49 GMT</small></p></td>
|
||||
<td align="right"><div class="copyright-footer"></div></td>
|
||||
</tr></table>
|
||||
<hr>
|
||||
|
@ -72,7 +72,7 @@
|
||||
Hartmut Kaiser for being review manager
|
||||
</li>
|
||||
<li class="listitem">
|
||||
Jonathan Turkanis for porting the lib (as far sa possible) to vc6 and vc7.
|
||||
Jonathan Turkanis for porting the lib (as far as possible) to vc6 and vc7.
|
||||
</li>
|
||||
</ul></div>
|
||||
<p>
|
||||
|
@ -105,7 +105,7 @@
|
||||
<li class="listitem">
|
||||
<code class="computeroutput"><span class="identifier">Traversal</span></code> is
|
||||
the tag used to identify the traversal of the resultant range.
|
||||
Frequently it is desireable to set a traversal category lower
|
||||
Frequently it is desirable to set a traversal category lower
|
||||
than the source container or range to maximize the number of
|
||||
ranges that can convert to the <code class="computeroutput"><span class="identifier">any_range</span></code>.
|
||||
If this is left as boost::use_default then <code class="computeroutput"><span class="identifier">Traversal</span></code>
|
||||
|
@ -43,7 +43,7 @@
|
||||
</h6>
|
||||
<p>
|
||||
<code class="computeroutput"><span class="identifier">fill_n</span></code> assigns the value
|
||||
<code class="computeroutput"><span class="identifier">val</span></code> to <code class="computeroutput"><span class="identifier">n</span></code> elements in the range <code class="computeroutput"><span class="identifier">rng</span></code> begining with <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code>.
|
||||
<code class="computeroutput"><span class="identifier">val</span></code> to <code class="computeroutput"><span class="identifier">n</span></code> elements in the range <code class="computeroutput"><span class="identifier">rng</span></code> beginning with <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code>.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="range.reference.algorithms.mutating.fill_n.h2"></a>
|
||||
|
@ -107,7 +107,7 @@
|
||||
Let <code class="computeroutput"><span class="identifier">x</span></code> be an object
|
||||
of <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s
|
||||
value type. Let <code class="computeroutput"><span class="identifier">y</span></code>
|
||||
be an obect of <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s
|
||||
be an object of <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code>'s
|
||||
value type. <code class="computeroutput"><span class="identifier">x</span> <span class="special"><</span>
|
||||
<span class="identifier">y</span></code> must be valid. <code class="computeroutput"><span class="identifier">y</span> <span class="special"><</span>
|
||||
<span class="identifier">x</span></code> must be valid.
|
||||
|
@ -109,7 +109,7 @@
|
||||
</h6>
|
||||
<p>
|
||||
<code class="computeroutput"><span class="identifier">mismatch</span></code> finds the first
|
||||
position where the correseponding elements from the two ranges <code class="computeroutput"><span class="identifier">rng1</span></code> and <code class="computeroutput"><span class="identifier">rng2</span></code>
|
||||
position where the corresponding elements from the two ranges <code class="computeroutput"><span class="identifier">rng1</span></code> and <code class="computeroutput"><span class="identifier">rng2</span></code>
|
||||
are not equal.
|
||||
</p>
|
||||
<p>
|
||||
|
@ -90,7 +90,7 @@
|
||||
<li class="listitem">
|
||||
An <code class="computeroutput"><span class="keyword">operator</span><span class="special">+</span></code>
|
||||
is defined for a left-hand operand of type <code class="computeroutput"><span class="identifier">Value</span></code>
|
||||
and a right-hand operance of the <code class="computeroutput"><span class="identifier">SinglePassRange</span></code>
|
||||
and a right-hand operand of the <code class="computeroutput"><span class="identifier">SinglePassRange</span></code>
|
||||
value type.
|
||||
</li>
|
||||
<li class="listitem">
|
||||
|
@ -44,7 +44,7 @@
|
||||
then one can still call all its member functions. This design decision
|
||||
avoids the <code class="computeroutput"><span class="identifier">iterator_range</span></code>
|
||||
imposing limitations upon ranges of iterators that are not singular. Any
|
||||
singularity limitation is simply propogated from the underlying iterator
|
||||
singularity limitation is simply propagated from the underlying iterator
|
||||
type.
|
||||
</p>
|
||||
<h5>
|
||||
|
@ -18,7 +18,7 @@ Let `Rng` be the type of `rng`.
|
||||
* [*Template parameters:]
|
||||
* `Value` is the `value_type` for the `any_range`. If this is set to boost::use_default, `Value` will be calculated from the
|
||||
range type when the adaptor is applied.
|
||||
* `Traversal` is the tag used to identify the traversal of the resultant range. Frequently it is desireable to set a traversal category lower than the source container or range to maximize the number of ranges that can convert to the `any_range`. If this is left as boost::use_default then `Traversal` will be `typename boost::iterator_traversal<boost::range_iterator<Rng>::type>::type`
|
||||
* `Traversal` is the tag used to identify the traversal of the resultant range. Frequently it is desirable to set a traversal category lower than the source container or range to maximize the number of ranges that can convert to the `any_range`. If this is left as boost::use_default then `Traversal` will be `typename boost::iterator_traversal<boost::range_iterator<Rng>::type>::type`
|
||||
* `Reference` is the `reference` for the `any_range`. `boost::use_default` will equate to `typename range_reference<Rng>::type`.
|
||||
* `Difference` is the `difference_type` for the any_range. `boost::use_default` will equate to `typename boost::range_difference<Rng>::type`
|
||||
* `Buffer` is the storage used to allocate the underlying iterator wrappers. This can typically be ignored, but is available as a template parameter for customization. Buffer must be a model of the `AnyIteratorBufferConcept`.
|
||||
|
@ -14,7 +14,7 @@ ForwardRange& fill( ForwardRange& rng, Size n, const Value& val );
|
||||
|
||||
[heading Description]
|
||||
|
||||
`fill_n` assigns the value `val` to `n` elements in the range `rng` begining with `boost::begin(rng)`.
|
||||
`fill_n` assigns the value `val` to `n` elements in the range `rng` beginning with `boost::begin(rng)`.
|
||||
|
||||
[heading Definition]
|
||||
|
||||
|
@ -41,7 +41,7 @@ Defined in the header file `boost/range/algorithm/lexicographical_compare.hpp`
|
||||
* `SinglePassRange2` is a model of the __single_pass_range__ Concept.
|
||||
* `SinglePassRange1`'s value type is a model of the `LessThanComparableConcept`.
|
||||
* `SinglePassRange2`'s value type is a model of the `LessThanComparableConcept`.
|
||||
* Let `x` be an object of `SinglePassRange1`'s value type. Let `y` be an obect of `SinglePassRange2`'s value type. `x < y` must be valid. `y < x` must be valid.
|
||||
* Let `x` be an object of `SinglePassRange1`'s value type. Let `y` be an object of `SinglePassRange2`'s value type. `x < y` must be valid. `y < x` must be valid.
|
||||
|
||||
[*For the predicate versions of lexicographical_compare:]
|
||||
|
||||
|
@ -80,7 +80,7 @@ mismatch(const SinglePassRange1& rng1, SinglePassRange2& rng2,
|
||||
|
||||
[heading Description]
|
||||
|
||||
`mismatch` finds the first position where the correseponding elements from the two ranges `rng1` and `rng2` are not equal.
|
||||
`mismatch` finds the first position where the corresponding elements from the two ranges `rng1` and `rng2` are not equal.
|
||||
|
||||
Equality is determined by `operator==` for non-predicate versions of `mismatch`, and by satisfying `pred` in the predicate versions.
|
||||
|
||||
|
@ -42,7 +42,7 @@ Defined in the header file `boost/range/numeric.hpp`
|
||||
|
||||
# `SinglePassRange` is a model of the __single_pass_range__ Concept.
|
||||
# `Value` is a model of the `AssignableConcept`.
|
||||
# An `operator+` is defined for a left-hand operand of type `Value` and a right-hand operance of the `SinglePassRange` value type.
|
||||
# An `operator+` is defined for a left-hand operand of type `Value` and a right-hand operand of the `SinglePassRange` value type.
|
||||
# The return type of the above operator is convertible to `Value`.
|
||||
|
||||
[heading For the second version]
|
||||
|
@ -21,7 +21,7 @@ The intention of the `iterator_range` class is to encapsulate two iterators so t
|
||||
|
||||
If the template argument is not a model of __forward_traversal_iterator__, one can still use a subset of the interface. In particular, `size()` requires Random Access Traversal Iterators whereas `empty()` only requires Single Pass Iterators.
|
||||
|
||||
Recall that many default constructed iterators are [*/singular/] and hence can only be assigned, but not compared or incremented or anything. However, if one creates a default constructed `iterator_range`, then one can still call all its member functions. This design decision avoids the `iterator_range` imposing limitations upon ranges of iterators that are not singular. Any singularity limitation is simply propogated from the underlying iterator type.
|
||||
Recall that many default constructed iterators are [*/singular/] and hence can only be assigned, but not compared or incremented or anything. However, if one creates a default constructed `iterator_range`, then one can still call all its member functions. This design decision avoids the `iterator_range` imposing limitations upon ranges of iterators that are not singular. Any singularity limitation is simply propagated from the underlying iterator type.
|
||||
|
||||
|
||||
[h4 Synopsis]
|
||||
|
Reference in New Issue
Block a user