Skip to content

Latest commit

 

History

History
139 lines (109 loc) · 4.18 KB

lexicographical_compare_three_way.md

File metadata and controls

139 lines (109 loc) · 4.18 KB
Raw

lexicographical_compare_three_way

  • algorithm[meta header]
  • std[meta namespace]
  • function[meta id-type]
  • cpp20[meta cpp]
namespace std {
  template<class InputIterator1, class InputIterator2, class Cmp>
    constexpr auto
      lexicographical_compare_three_way(
        InputIterator1 first1,
        InputIterator1 last1,
        InputIterator2 first2,
        InputIterator2 last2,
        Cmp comp)
        -> decltype(comp(*first1, *first2)); // (1)

  template<class InputIterator1, class InputIterator2>
    constexpr auto
      lexicographical_compare_three_way(
        InputIterator1 first1,
        InputIterator1 last1,
        InputIterator2 first2,
        InputIterator2 last2);               // (2)
}

概要

[first1, last1)および[first2, last2)の2つの範囲を辞書式順序による三方比較によって比較する。 このアルゴリズムは、コンテナのoperator<=>()の実装で使用される。

適格要件

引数

  • first1 -- 比較する1つ目の範囲の先頭のイテレータ。
  • last1 -- 比較する1つ目の範囲の終端のイテレータ。
  • first2 -- 比較する2つ目の範囲の先頭のイテレータ。
  • last2 -- 比較する2つ目の範囲の終端のイテレータ。
  • comp -- 使用する三方比較をカスタマイズする関数オブジェクト。

効果

  • (1) : 以下と等価

    for ( ; first1 != last1 && first2 != last2; void(++first1), void(++first2) )
  if (auto cmp = comp(*first1, *first2); cmp != 0)
    return cmp;
return first1 != last1 ? strong_ordering::greater :
       first2 != last2 ? strong_ordering::less :
                         strong_ordering::equal;

  • (2) : 以下と等価、すなわち(1)に委譲

    return lexicographical_compare_three_way(first1, last1, first2, last2, compare_three_way());
    • compare_three_way[link /reference/compare/compare_three_way.md]

戻り値

戻り値型となる比較カテゴリ型をCatとすると、
範囲[first1, last1)が、辞書式比較で範囲[first2, last2)より大きい場合はCat::greatorを返し、小さい場合Cat::lessを返し、等しいのならばCat::equivalentを返す。

例

#include <iostream>
#include <compare>
#include <algorithm>
#include <cctype>

//大文字小文字を同値として扱って比較
auto weak_comp = [](char cl, char cr) -> std::weak_ordering {
  char c1, c2;
  if (std::isalpha(static_cast<unsigned char>(cl)) && std::isalpha(static_cast<unsigned char>(cr))) {
    c1 = std::tolower(cl);
    c2 = std::tolower(cr);
  } else {
    c1 = cl;
    c2 = cr;
  }
  return c1 <=> c2;
};

int main() {
  std::string str1 = "abcdefghijklmnopqrstuvwxyz";
  std::string str2 = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
  std::string str3 = "abcdefghijklm";

  std::cout << std::boolalpha;

  //カスタマイズした比較による同じ長さの範囲の比較
  {
    auto comp = std::lexicographical_compare_three_way(str1.begin(), str1.end(), str2.begin(), str2.end(), weak_comp);
    std::cout << (comp == 0) << std::endl;
  }

  //デフォルトの比較による異なる長さの範囲の比較
  {
    auto comp = std::lexicographical_compare_three_way(str1.begin(), str1.end(), str3.begin(), str3.end());
    std::cout << (comp > 0) << std::endl;
  }
}
  • weak_ordering[link /reference/compare/weak_ordering.md]

出力例

true
true

バージョン

言語

  • C++20

処理系

関連項目

参照