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

比较两个字符序列。

从 data1 开始的由 count1 个字符组成的字符序列，与从 data2 开始的由 count2 个字符组成的字符序列按如下方式进行比较：

• 首先，计算需要比较的字符数量，方式类似于 size_type rlen = std:: min ( count1, count2 ) 。
• 随后通过调用 Traits :: compare ( data1, data2, rlen ) 来比较序列。对于标准字符串，该函数会执行逐字符的字典序比较。若比较结果为零（表示字符序列至此完全相等），则按如下方式比较它们的尺寸：

参数

返回值

• 负值，若 * this 按字典序出现在参数指定的字符序列之前。
• 零，若两个字符序列比较结果等价。
• 正值，若 * this 按字典序出现在参数指定的字符序列之后。

异常

接受名为 pos1 或 pos2 参数的重载函数，在参数超出范围时会抛出 std::out_of_range 异常。

若因任何原因抛出异常，此函数不产生任何效果（ 强异常安全保证 ）。

可能的实现

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) << " 位于 "
                  << std::quoted(str2) << " 之前。\n";
    else if (compare_result > 0)
        std::cout << std::quoted(str2) << " 位于 "
                  << std::quoted(str1) << " 之前。\n";
    else
        std::cout << std::quoted(str1) << " 和 "
                  << std::quoted(str2) << " 相同。\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" 位于 "Superman" 之前。
2) "Superman" 位于 "man" 之前。
3) "man" 和 "man" 相同。
4) "Batman" 位于 "Superman" 之前。
5) "Superman" 位于 "man" 之前。
6) "Bat" 位于 "Super" 之前。

缺陷报告

以下行为变更缺陷报告被追溯应用于先前发布的C++标准。

参见