Namespaces
Variants
Views
Actions

std::is_sorted

From cppreference.com
< cpp‎ | algorithm
Revision as of 19:30, 2 November 2012 by P12bot (Talk | contribs)

 
 
 

Template:ddcl list begin <tr class="t-dsc-header">

<td>
Defined in header <algorithm>
</td>

<td></td> <td></td> <tr class="t-dcl ">

<td >
template< class ForwardIt >
bool is_sorted( ForwardIt first, ForwardIt last );
</td>

<td > (1) </td> <td > (since C++11) </td> </tr> <tr class="t-dcl ">

<td >
template< class ForwardIt, class Compare >
bool is_sorted( ForwardIt first, ForwardIt last, Compare comp );
</td>

<td > (2) </td> <td > (since C++11) </td> </tr> Template:ddcl list end

Checks if the elements in range [first, last) are sorted in ascending order. The first version of the function uses operator< to compare the elements, the second uses the given comparison function comp.

Contents

Parameters

first, last - the range of elements to examine
comp - comparison function object (i.e. an object that satisfies the requirements of Compare) which returns ​true if the first argument is less than the second.

The signature of the comparison function should be equivalent to the following:

 bool cmp(const Type1 &a, const Type2 &b);

The signature does not need to have const &, but the function object must not modify the objects passed to it.
The types Type1 and Type2 must be such that an object of type ForwardIt can be dereferenced and then implicitly converted to both of them. ​

Type requirements
-
ForwardIt must meet the requirements of ForwardIterator.

Return value

true if the elements in the range are sorted in ascending order

Complexity

linear in the distance between first and last

Possible implementation

First version
template<class ForwardIt>
bool is_sorted(ForwardIt first, ForwardIt last)
{
    return std::is_sorted_until(first, last) == last;
}
Second version
template<class ForwardIt, class Compare>
bool is_sorted(ForwardIt first, ForwardIt last, Compare comp)
{
    return std::is_sorted_until(first, last, comp) == last;
}

Example

#include <iostream>
#include <algorithm>
 
int main() 
{
    const int N = 5;
    int digits[N] = {3, 1, 4, 1, 5};
 
    for (auto i : digits) std::cout << i << ' ';
    std::cout << ": is_sorted: " << std::is_sorted(digits, digits+N) << '\n';
 
    std::sort(digits, digits+N);
 
    for (auto i : digits) std::cout << i << ' ';
    std::cout << ": is_sorted: " << std::is_sorted(digits, digits+N) << '\n';
}

Output:

3 1 4 1 5 : is_sorted: 0
1 1 3 4 5 : is_sorted: 1

See also

Template:cpp/algorithm/dcl list is sorted until