std::lexicographical_compare_three_way

Определено в заголовке <algorithm>

Определено в заголовке `<algorithm>`
template< class InputIt1, class InputIt2, class Cmp > constexpr auto lexicographical_compare_three_way( InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2, Cmp comp ) -> decltype(comp(first1, first2));	(1)	(с C++20)
template< class InputIt1, class InputIt2 > constexpr auto lexicographical_compare_three_way( InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2 );	(2)	(с C++20)

template< class InputIt1, class InputIt2, class Cmp >
constexpr auto lexicographical_compare_three_way( InputIt1 first1, InputIt1 last1,
                                                  InputIt2 first2, InputIt2 last2,
                                                  Cmp comp )
    -> decltype(comp(*first1, *first2));

(1)

(с C++20)

template< class InputIt1, class InputIt2 >
constexpr auto lexicographical_compare_three_way( InputIt1 first1, InputIt1 last1,
                                                  InputIt2 first2, InputIt2 last2 );

(2)

(с C++20)

Лексикографически сравнивает два диапазона [first1, last1) и [first2, last2) с использованием трёхстороннего сравнения и возвращает результат с использованием наиболее сильного применимого типа категории сравнения.

1) Возвращает порядок между первой неэквивалентной парой элементов в соответствии с comp в обоих диапазонах, если таковая имеется, в противном случае (если один диапазон эквивалентен префиксу другого в соответствии с comp), возвращает порядок между длинами обоих диапазонов.

2) Эквивалентно:

return std::lexicographical_compare_three_way(
    first1, last1, first2, last2, std::compare_three_way());

Параметры

first1, last1	-	первый диапазон элементов для проверки
first2, last2	-	второй диапазон элементов для проверки
comp	-	объект-функция. Программа является некорректной, если её тип возвращаемого значения не является одним из трёх типов категорий сравнения (`std::strong_ordering`, `std::weak_ordering` или `std::partial_ordering`).
Требования к типу
-`InputIt1, InputIt2` должны соответствовать требованиям LegacyInputIterator.

Возвращаемое значение

Значение типа категории сравнения, указанного выше.

Сложность

Максимум N применений comp, где N — меньшая из длин обоих диапазонов.

Возможная реализация

template<class I1, class I2, class Cmp>
constexpr auto lexicographical_compare_three_way(I1 f1, I1 l1, I2 f2, I2 l2, Cmp comp)
    -> decltype(comp(*f1, *f2))
{
    using ret_t = decltype(comp(*f1, *f2));
    static_assert(std::disjunction_v<
                      std::is_same<ret_t, std::strong_ordering>,
                      std::is_same<ret_t, std::weak_ordering>,
                      std::is_same<ret_t, std::partial_ordering>>,
                  "The return type must be a comparison category type.");
 
    bool exhaust1 = (f1 == l1);
    bool exhaust2 = (f2 == l2);
    for (; !exhaust1 && !exhaust2; exhaust1 = (++f1 == l1), exhaust2 = (++f2 == l2))
        if (auto c = comp(*f1, *f2); c != 0)
            return c;
 
    return !exhaust1 ? std::strong_ordering::greater:
           !exhaust2 ? std::strong_ordering::less:
                       std::strong_ordering::equal;
}

Пример

#include <algorithm>
#include <cctype>
#include <compare>
#include <iomanip>
#include <iostream>
#include <string_view>
#include <utility>
using namespace std::literals;
 
void show_result(std::string_view s1, std::string_view s2, std::strong_ordering o)
{
    std::cout << std::quoted(s1) << " is ";
    std::is_lt(o) ? std::cout << "less than ":
    std::is_gt(o) ? std::cout << "greater than ":
                    std::cout << "equal to ";
    std::cout << std::quoted(s2) << '\n';
}
 
std::strong_ordering cmp_icase(unsigned char x, unsigned char y)
{
    return std::toupper(x) <=> std::toupper(y);
};
 
int main()
{
    for (const auto& [s1, s2] :
    {
        std::pair{"one"sv, "ONE"sv}, {"two"sv, "four"sv}, {"three"sv, "two"sv}
    })
    {
        const auto res = std::lexicographical_compare_three_way(
            s1.cbegin(), s1.cend(), s2.cbegin(), s2.cend(), cmp_icase);
        show_result(s1, s2, res);
    }
}

Вывод:

"one" is equal to "ONE"
"two" is greater than "four"
"three" is less than "two"

Отчёты об ошибках

Следующие отчёты об ошибках, изменяющие поведение, были применены ретроактивно к ранее опубликованным стандартам C++.

DR	Применён к	Поведение, как опубликовано	Правильное поведение
LWG 3410	C++20	требовались лишние сравнения между итераторами	такое требование было удалено

См. также

lexicographical_compare	возвращает `true` если один диапазон лексикографически меньше другого (шаблон функции)
compare_three_way (C++20)	объект-функция, реализующий `x <=> y` (класс)
ranges::lexicographical_compare (C++20)	возвращает `true` если один диапазон лексикографически меньше другого (niebloid)

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/w/cpp/algorithm/lexicographical_compare_three_way