[Boost-commit] svn:boost r86200 - branches/release/libs/algorithm/doc

Subject: [Boost-commit] svn:boost r86200 - branches/release/libs/algorithm/doc
From: marshall_at_[hidden]
Date: 2013-10-08 11:31:14

Author: marshall
Date: 2013-10-08 11:31:14 EDT (Tue, 08 Oct 2013)
New Revision: 86200
URL: http://svn.boost.org/trac/boost/changeset/86200

Log:
Merge minor Boost.Algorithm doc fixes to the release branch

Properties modified: 
   branches/release/libs/algorithm/doc/   (props changed)
   branches/release/libs/algorithm/doc/one_of.qbk   (contents, props changed)
Text files modified: 
   branches/release/libs/algorithm/doc/equal.qbk    |     2 +-                                      
   branches/release/libs/algorithm/doc/mismatch.qbk |     2 +-                                      
   branches/release/libs/algorithm/doc/one_of.qbk   |     2 +-                                      
   3 files changed, 3 insertions(+), 3 deletions(-)

Modified: branches/release/libs/algorithm/doc/equal.qbk
==============================================================================
--- branches/release/libs/algorithm/doc/equal.qbk	Tue Oct  8 10:44:59 2013	(r86199)
+++ branches/release/libs/algorithm/doc/equal.qbk	2013-10-08 11:31:14 EDT (Tue, 08 Oct 2013)	(r86200)
@@ -22,7 +22,7 @@
         
         std::equal ( seq1.begin (), seq1.end (), seq2.begin ()); // true
         std::equal ( seq2.begin (), seq2.end (), seq1.begin ()); // Undefined behavior
-	std::equal ( seq1.begin (), seq1.end (), seq1.begin (), seq2.end ()); // false
+	std::equal ( seq1.begin (), seq1.end (), seq2.begin (), seq2.end ()); // false
 ```
 
 You can argue that `true` is the correct answer in the first case, even though the sequences are not the same. The first N entries in `seq2` are the same as the entries in `seq1` - but that's not all that's in `seq2`. But in the second case, the algorithm will read past the end of `seq1`, resulting in undefined behavior (large earthquake, incorrect results, pregnant cat, etc).

Modified: branches/release/libs/algorithm/doc/mismatch.qbk
==============================================================================
--- branches/release/libs/algorithm/doc/mismatch.qbk	Tue Oct  8 10:44:59 2013	(r86199)
+++ branches/release/libs/algorithm/doc/mismatch.qbk	2013-10-08 11:31:14 EDT (Tue, 08 Oct 2013)	(r86200)
@@ -22,7 +22,7 @@
         
         std::mismatch ( seq1.begin (), seq1.end (), seq2.begin ()); // <3, 3>
         std::mismatch ( seq2.begin (), seq2.end (), seq1.begin ()); // Undefined behavior
-	std::mismatch ( seq1.begin (), seq1.end (), seq1.begin (), seq2.end ()); // <3, 3>
+	std::mismatch ( seq1.begin (), seq1.end (), seq2.begin (), seq2.end ()); // <3, 3>
 ```
 
 The first N entries in `seq2` are the same as the entries in `seq1` - but that's not all that's in `seq2`. In the second case, the algorithm will read past the end of `seq1`, resulting in undefined behavior (large earthquake, incorrect results, pregnant cat, etc).

Modified: branches/release/libs/algorithm/doc/one_of.qbk
==============================================================================
--- branches/release/libs/algorithm/doc/one_of.qbk	Tue Oct  8 10:44:59 2013	(r86199)
+++ branches/release/libs/algorithm/doc/one_of.qbk	2013-10-08 11:31:14 EDT (Tue, 08 Oct 2013)	(r86200)
@@ -75,7 +75,7 @@
 
 * `one_of` and `one_of_equal` both return false for empty ranges, no matter what is passed to test against. 
 
-* The second parameter to `one_of_value` is a template parameter, rather than deduced from the first parameter (`std::iterator_traits<InputIterator>::value_type`) because that allows more flexibility for callers, and takes advantage of built-in comparisons for the type that is pointed to by the iterator.  The function is defined to return true if, for one element in the sequence, the expression `*iter == val` evaluates to true (where `iter` is an iterator to each element in the sequence)
+* The second parameter to `one_of_equal` is a template parameter, rather than deduced from the first parameter (`std::iterator_traits<InputIterator>::value_type`) because that allows more flexibility for callers, and takes advantage of built-in comparisons for the type that is pointed to by the iterator.  The function is defined to return true if, for one element in the sequence, the expression `*iter == val` evaluates to true (where `iter` is an iterator to each element in the sequence)
 
 [endsect]