forked from boostorg/algorithm
Removed empty README.md, fixed docs
This commit is contained in:
@ -1,4 +0,0 @@
|
|||||||
<a href="https://scan.coverity.com/projects/zamazan4ik-algorithm">
|
|
||||||
<img alt="Coverity Scan Build Status"
|
|
||||||
src="https://scan.coverity.com/projects/10628/badge.svg"/>
|
|
||||||
</a>
|
|
@ -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.
|
* 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]
|
[endsect]
|
||||||
|
|
||||||
|
@ -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 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.
|
`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]
|
[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<typename InputIterator, typename Predicate>
|
template<typename InputIterator, typename Predicate>
|
||||||
@ -55,7 +55,7 @@ Both of the variants of `is_partitioned_until` take their parameters by value or
|
|||||||
|
|
||||||
[heading Notes]
|
[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]
|
[endsect]
|
||||||
|
|
||||||
|
@ -18,7 +18,8 @@
|
|||||||
namespace boost { namespace algorithm {
|
namespace boost { namespace algorithm {
|
||||||
|
|
||||||
/// \fn is_partitioned ( InputIterator first, InputIterator last, UnaryPredicate p )
|
/// \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 first The start of the input sequence
|
||||||
/// \param last One past the end 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 )
|
/// \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 r The input range
|
||||||
/// \param p The predicate to test the values with
|
/// \param p The predicate to test the values with
|
||||||
|
@ -18,7 +18,8 @@
|
|||||||
namespace boost { namespace algorithm {
|
namespace boost { namespace algorithm {
|
||||||
|
|
||||||
/// \fn is_partitioned_until ( InputIterator first, InputIterator last, UnaryPredicate p )
|
/// \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 first The start of the input sequence
|
||||||
/// \param last One past the end 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 )
|
/// \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 r The input range
|
||||||
/// \param p The predicate to test the values with
|
/// \param p The predicate to test the values with
|
||||||
|
Reference in New Issue
Block a user