std::lexicographical_compare_three_way

ヘッダー `<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以降)

辞書順で2つの範囲 [first1, last1) と [first2, last2) を3方向比較で比較し、適用可能な中で最も強い比較カテゴリ型の結果を生成します。

1) 両方の範囲で、comp に基づいて最初に等しくない要素のペア間の順序を返します。もしそのようなペアがない場合（一方の範囲が、comp に基づいてもう一方の範囲のプレフィックスと等しい場合）、両方の範囲の長さの間の順序を返します。

2) return std::lexicographical_compare_three_way(
first1, last1, first2, last2, std::compare_three_way()); と同等です。

戻り値の型が3つの比較カテゴリ型のいずれでもない場合、プログラムは不正形式です。

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 を返す (アルゴリズム関数オブジェクト)[編集]

コンパイラサポート
フリースタンディングとホスト
言語
標準ライブラリ
標準ライブラリヘッダー
名前付き要件
機能テストマクロ (C++20)
言語サポートライブラリ
コンセプトライブラリ (C++20)
診断ライブラリ
メモリ管理ライブラリ
メタプログラミングライブラリ (C++11)
汎用ユーティリティライブラリ
コンテナライブラリ
イテレータライブラリ
Rangesライブラリ (C++20)
アルゴリズムライブラリ
文字列ライブラリ
テキスト処理ライブラリ
数値ライブラリ
日付と時刻ライブラリ
入出力ライブラリ
ファイルシステムライブラリ (C++17)
並行サポートライブラリ (C++11)
実行制御ライブラリ (C++26)
Technical specifications (技術仕様)
シンボルインデックス
外部ライブラリ

cppreference.com

名前空間

変種

表示

操作

std::lexicographical_compare_three_way

目次

[編集] パラメータ

[編集] 戻り値

[編集] 複雑性

[編集] 実装例

[編集] 例

[編集] 不具合報告

[編集] 関連項目

ナビゲーション

ツールボックス

first1, last1	-	調べる最初の要素の範囲を定義するイテレータのペア
first2, last2	-	調べる2番目の要素の範囲を定義するイテレータのペア
comp	-	関数オブジェクト
型要件
- `InputIt1, InputIt2` は LegacyInputIterator の要件を満たす必要がある。