diff --git a/README.md b/README.md deleted file mode 100644 index 92a9140..0000000 --- a/README.md +++ /dev/null @@ -1,4 +0,0 @@ - - Coverity Scan Build Status - diff --git a/doc/is_partitioned.qbk b/doc/is_partitioned.qbk index 7a6c458..0ed1f80 100644 --- a/doc/is_partitioned.qbk +++ b/doc/is_partitioned.qbk @@ -57,7 +57,7 @@ Both of the variants of `is_partitioned` take their parameters by value or const * The iterator-based version of the routine `is_partitioned` is also available as part of the C++11 standard. -* `is_partitioned` returns true for empty ranges, no matter what predicate is passed to test against. +* `is_partitioned` returns true for empty and single-element ranges, no matter what predicate is passed to test against. [endsect] diff --git a/doc/is_partitioned_until.qbk b/doc/is_partitioned_until.qbk index 72e2afc..9e0879b 100644 --- a/doc/is_partitioned_until.qbk +++ b/doc/is_partitioned_until.qbk @@ -11,14 +11,14 @@ Distributed under the Boost Software License, Version 1.0. The header file 'is_partitioned_until.hpp' contains two variants of a single algorithm, `is_partitioned_until`. The algorithm tests to see if a sequence is partitioned according to a predicate; in other words, all the items in the sequence that satisfy the predicate are at the beginning of the sequence. -The routine `is_partitioned_until` takes a sequence and a predicate. It returns the first iterator 'it' in the sequence [first, last) for which is_partitioned(first, it, p) is false. Returns last if the entire sequence is partitioned. +The routine `is_partitioned_until` takes a sequence and a predicate. It returns the last iterator 'it' in the sequence [begin, end) for which the is_partitioned(begin, it) is true. `is_partitioned_until` come in two forms; the first one takes two iterators to define the range. The second form takes a single range parameter, and uses Boost.Range to traverse it. [heading interface] -The function `is_partitioned_until` returns the first iterator 'it' in the sequence [first, last) for which is_partitioned(first, it, p) is false. Returns last if the entire sequence is partitioned. There are two versions; one takes two iterators, and the other takes a range. +The function `is_partitioned_until` returns the last iterator 'it' in the sequence [begin, end) for which the is_partitioned(begin, it) is true. There are two versions; one takes two iterators, and the other takes a range. `` template @@ -55,7 +55,7 @@ Both of the variants of `is_partitioned_until` take their parameters by value or [heading Notes] -* `is_partitioned_until` returns iterator to the end for empty ranges, no matter what predicate is passed to test against. +* `is_partitioned_until` returns iterator to the end for empty and single-element ranges, no matter what predicate is passed to test against. [endsect] diff --git a/include/boost/algorithm/cxx11/is_partitioned.hpp b/include/boost/algorithm/cxx11/is_partitioned.hpp index 80ee577..c0076b9 100644 --- a/include/boost/algorithm/cxx11/is_partitioned.hpp +++ b/include/boost/algorithm/cxx11/is_partitioned.hpp @@ -18,7 +18,8 @@ namespace boost { namespace algorithm { /// \fn is_partitioned ( InputIterator first, InputIterator last, UnaryPredicate p ) -/// \brief Tests to see if a sequence is partitioned according to a predicate +/// \brief Tests to see if a sequence is partitioned according to a predicate. +/// In other words, all the items in the sequence that satisfy the predicate are at the beginning of the sequence. /// /// \param first The start of the input sequence /// \param last One past the end of the input sequence @@ -39,7 +40,8 @@ bool is_partitioned ( InputIterator first, InputIterator last, UnaryPredicate p } /// \fn is_partitioned ( const Range &r, UnaryPredicate p ) -/// \brief Tests to see if a sequence is partitioned according to a predicate +/// \brief Tests to see if a sequence is partitioned according to a predicate. +/// In other words, all the items in the sequence that satisfy the predicate are at the beginning of the sequence. /// /// \param r The input range /// \param p The predicate to test the values with diff --git a/include/boost/algorithm/is_partitioned_until.hpp b/include/boost/algorithm/is_partitioned_until.hpp index 99e8435..42683e1 100644 --- a/include/boost/algorithm/is_partitioned_until.hpp +++ b/include/boost/algorithm/is_partitioned_until.hpp @@ -18,7 +18,8 @@ namespace boost { namespace algorithm { /// \fn is_partitioned_until ( InputIterator first, InputIterator last, UnaryPredicate p ) -/// \brief Tests to see if a sequence is partitioned according to a predicate +/// \brief Tests to see if a sequence is partitioned according to a predicate. +/// In other words, all the items in the sequence that satisfy the predicate are at the beginning of the sequence. /// /// \param first The start of the input sequence /// \param last One past the end of the input sequence @@ -42,7 +43,8 @@ InputIterator is_partitioned_until ( InputIterator first, InputIterator last, Un } /// \fn is_partitioned_until ( const Range &r, UnaryPredicate p ) -/// \brief Tests to see if a sequence is partitioned according to a predicate +/// \brief Tests to see if a sequence is partitioned according to a predicate. +/// In other words, all the items in the sequence that satisfy the predicate are at the beginning of the sequence. /// /// \param r The input range /// \param p The predicate to test the values with