std::basic_string<CharT,Traits,Allocator>:: compare

2つの文字シーケンスを比較します。

count1 文字からなる文字シーケンス（ data1 から開始）が、 count2 文字からなる文字シーケンス（ data2 から開始）と次のように比較されます：

• まず、比較する文字数を計算します。計算方法は size_type rlen = std:: min ( count1, count2 ) のように行います。
• 次に、シーケンスを比較するために Traits :: compare ( data1, data2, rlen ) を呼び出します。標準文字列の場合、この関数は文字単位の辞書順比較を実行します。結果がゼロ（これまでの文字シーケンスが等しい）の場合、それらのサイズは以下のように比較されます：

パラメータ

戻り値

• 引数で指定された文字シーケンスより、辞書順で * this が前に現れる場合は負の値。
• 両方の文字シーケンスが等価な場合はゼロ。
• 引数で指定された文字シーケンスより、辞書順で * this が後に現れる場合は正の値。

例外

pos1 または pos2 という名前のパラメータを受け取るオーバーロードは、 引数が範囲外の場合 std::out_of_range をスローします。

何らかの理由で例外がスローされた場合、この関数は何も効果を持ちません（ strong exception safety guarantee ）。

実装例

template<class CharT, class Traits, class Alloc>
int std::basic_string<CharT, Traits, Alloc>::compare
    (const std::basic_string& s) const noexcept
{
    size_type lhs_sz = size();
    size_type rhs_sz = s.size();
    int result = traits_type::compare(data(), s.data(), std::min(lhs_sz, rhs_sz));
    if (result != 0)
        return result;
    if (lhs_sz < rhs_sz)
        return -1;
    if (lhs_sz > rhs_sz)
        return 1;
    return 0;
}

注記

三方比較が不要な状況では、 std::basic_string は通常の 関係演算子 ( < , <= , == , > , など) を提供します。

デフォルトでは（デフォルトの std::char_traits を使用した場合）、この関数はロケール依存ではありません。ロケールを考慮した三方文字列比較については、 std::collate::compare を参照してください。

例

#include <cassert>
#include <iomanip>
#include <iostream>
#include <string>
#include <string_view>
void print_compare_result(std::string_view str1,
                          std::string_view str2,
                          int compare_result)
{
    if (compare_result < 0)
        std::cout << std::quoted(str1) << " comes before "
                  << std::quoted(str2) << ".\n";
    else if (compare_result > 0)
        std::cout << std::quoted(str2) << " comes before "
                  << std::quoted(str1) << ".\n";
    else
        std::cout << std::quoted(str1) << " and "
                  << std::quoted(str2) << " are the same.\n";
}
int main()
{
    std::string batman{"Batman"};
    std::string superman{"Superman"};
    int compare_result{0};
    // 1) 他の文字列と比較
    compare_result = batman.compare(superman);
    std::cout << "1) ";
    print_compare_result("Batman", "Superman", compare_result);
    // 2) 部分文字列を他の文字列と比較
    compare_result = batman.compare(3, 3, superman);
    std::cout << "2) ";
    print_compare_result("man", "Superman", compare_result);
    // 3) 部分文字列を他の部分文字列と比較
    compare_result = batman.compare(3, 3, superman, 5, 3);
    std::cout << "3) ";
    print_compare_result("man", "man", compare_result);
    // 部分文字列を他の部分文字列と比較
    // 他の文字列の末尾をデフォルトとして使用
    assert(compare_result == batman.compare(3, 3, superman, 5));
    // 4) 文字ポインタと比較
    compare_result = batman.compare("Superman");
    std::cout << "4) ";
    print_compare_result("Batman", "Superman", compare_result);
    // 5) 部分文字列を文字ポインタと比較
    compare_result = batman.compare(3, 3, "Superman");
    std::cout << "5) ";
    print_compare_result("man", "Superman", compare_result);
    // 6) 部分文字列を文字ポインタの部分文字列と比較
    compare_result = batman.compare(0, 3, "Superman", 5);
    std::cout << "6) ";
    print_compare_result("Bat", "Super", compare_result);
}

1) "Batman" comes before "Superman".
2) "Superman" comes before "man".
3) "man" and "man" are the same.
4) "Batman" comes before "Superman".
5) "Superman" comes before "man".
6) "Bat" comes before "Super".

不具合報告

以下の動作変更の欠陥報告書は、以前に公開されたC++規格に対して遡及的に適用されました。

関連項目