Namespaces
Variants
Views
Actions

std::ranges::is_sorted

From cppreference.com
< cpp‎ | algorithm‎ | ranges
 
 
Algorithm library
Constrained algorithms and algorithms on ranges (C++20)
Constrained algorithms: std::ranges::copy, std::ranges::sort, ...
Execution policies (C++17)
Non-modifying sequence operations
(C++11)(C++11)(C++11)
(C++17)
Modifying sequence operations
Operations on uninitialized storage
Partitioning operations
Sorting operations
(C++11)
Binary search operations
Set operations (on sorted ranges)
Heap operations
(C++11)
Minimum/maximum operations
(C++11)
(C++17)

Permutations
Numeric operations
C library
 
Constrained algorithms
Non-modifying sequence operations
Modifying sequence operations
Operations on uninitialized storage
Partitioning operations
Sorting operations
ranges::is_sorted
Binary search operations
Set operations (on sorted ranges)
Heap operations
Minimum/maximum operations
Permutations
 
Defined in header <algorithm>
Call signature
template< std::forward_iterator I, std::sentinel_for<I> S, class Proj = std::identity,

          std::indirect_strict_weak_order<std::projected<I, Proj>> Comp = ranges::less >

constexpr bool is_sorted( I first, S last, Comp comp = {}, Proj proj = {} );
(1) (since C++20)
template< ranges::forward_range R, class Proj = std::identity,

          std::indirect_strict_weak_order<
              std::projected<ranges::iterator_t<R>, Proj>> Comp = ranges::less >

constexpr bool is_sorted( R&& r, Comp comp = {}, Proj proj = {} );
(2) (since C++20)

Checks if the elements in range [first, last) are sorted in non-descending order.

A sequence is sorted with respect to a comparator comp if for any iterator it pointing to the sequence and any non-negative integer n such that it + n is a valid iterator pointing to an element of the sequence, std::invoke(comp, std::invoke(proj, *(it + n)), std::invoke(proj, *it)) evaluates to false.

1) Elements are compared using the given binary comparison function comp.
2) Same as (1), but uses r as the source range, as if using ranges::begin(r) as first and ranges::end(r) as last.

The function-like entities described on this page are niebloids, that is:

In practice, they may be implemented as function objects, or with special compiler extensions.

Contents

[edit] Parameters

first, last - iterator-sentinel defining the range to check if it is sorted
r - the range to check if it is sorted
comp - comparison function to apply to the projected elements
proj - projection to apply to the elements

[edit] Return value

true if the elements in the range are sorted according to comp.

[edit] Complexity

Linear in the distance between first and last.

[edit] Possible implementation

struct is_sorted_fn {
  template<std::forward_iterator I, std::sentinel_for<I> S, class Proj = std::identity,
           std::indirect_strict_weak_order<std::projected<I, Proj>> Comp = ranges::less>
  constexpr bool operator()(I first, S last, Comp comp = {}, Proj proj = {}) const
  {
      return ranges::is_sorted_until(first, last, comp, proj) == last;
  }
 
  template<ranges::forward_range R, class Proj = std::identity,
           std::indirect_strict_weak_order<
               std::projected<ranges::iterator_t<R>, Proj>> Comp = ranges::less>
  constexpr bool operator()(R&& r, Comp comp = {}, Proj proj = {}) const
  {
      return (*this)(ranges::begin(r), ranges::end(r),
                     std::ref(comp), std::ref(proj));
  }
};
 
inline constexpr is_sorted_fn is_sorted;

[edit] Notes

ranges::is_sorted returns true for empty ranges and ranges of length one.

[edit] Example

#include <algorithm>
#include <iostream>
#include <iterator>
 
int main()
{
    std::array<int, 5> digits = {3, 1, 4, 1, 5};
 
    ranges::copy(digits, std::ostream_iterator<int>(std::cout, " "));
    std::cout << ": is_sorted: " << std::boolalpha
              << ranges::is_sorted(digits) << '\n';
 
    ranges::sort(digits);
 
    ranges::copy(digits, std::ostream_iterator<int>(std::cout, " "));
    std::cout << ": is_sorted: "
              << ranges::is_sorted(ranges::begin(digits), ranges::end(digits)) << '\n';
}

Output:

3 1 4 1 5 : is_sorted: false
1 1 3 4 5 : is_sorted: true

[edit] See also

finds the largest sorted subrange
(niebloid) [edit]
(C++11)
checks whether a range is sorted into ascending order
(function template) [edit]