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

int compare( const basic_string& str ) const;	(1)	(C++11 起无异常抛出) (C++20 起为 constexpr)
int compare( size_type pos1, size_type count1, const basic_string& str ) const;	(2)	(C++20 起为 constexpr)
	(3)
int compare( size_type pos1, size_type count1, const basic_string& str, size_type pos2, size_type count2 ) const;			(until C++14)
int compare( size_type pos1, size_type count1, const basic_string& str, size_type pos2, size_type count2 = npos ) const;			(C++14 起) (C++20 起为 constexpr)
int compare( const CharT* s ) const;		(4)	(C++20 起为 constexpr)
int compare( size_type pos1, size_type count1, const CharT* s ) const;		(5)	(C++20 起为 constexpr)
int compare( size_type pos1, size_type count1, const CharT* s, size_type count2 ) const;		(6)	(C++20 起为 constexpr)
template< class StringViewLike > int compare( const StringViewLike& t ) const noexcept(/* see below */);		(7)	(C++17 起) (C++20 起为 constexpr)
template< class StringViewLike > int compare( size_type pos1, size_type count1, const StringViewLike& t ) const;		(8)	(C++17 起) (C++20 起为 constexpr)
template< class StringViewLike > int compare( size_type pos1, size_type count1, const StringViewLike& t, size_type pos2, size_type count2 = npos) const;		(9)	(C++17 起) (C++20 起为 constexpr)

比较两个字符序列。

1) 将此字符串与 str 进行比较。

2) 将此字符串的 [pos1, pos1 + count1) 子字符串与 str 进行比较。

如果 count1 > size() - pos1，则子字符串为 [pos1, size())。

3) 将此字符串的 [pos1, pos1 + count1) 子字符串与 str 的子字符串 [pos2, pos2 + count2) 进行比较。

如果 count1 > size() - pos1，则第一个子字符串为 [pos1, size())。
如果 count2 > str.size() - pos2，则第二个子字符串为 [pos2, str.size())。

4) 将此字符串与从 s 指向的字符开始，长度为 Traits::length(s) 的空终止字符序列进行比较。

5) 将此字符串的 [pos1, pos1 + count1) 子字符串与从 s 指向的字符开始，长度为 Traits::length(s) 的空终止字符序列进行比较。

如果 count1 > size() - pos1，则子字符串为 [pos1, size())。

6) 将此字符串的 [pos1, pos1 + count1) 子字符串与范围 [s, s + count2) 中的字符进行比较。范围 [s, s + count2) 中的字符可以包含空字符。

如果 count1 > size() - pos1，则子字符串为 [pos1, size())。

7-9) 将 t 隐式转换为字符串视图 sv，如同通过 std::basic_string_view<CharT, Traits> sv = t;，然后：

7) 将此字符串与 sv 进行比较；

8) 将此字符串的 [pos1, pos1 + count1) 子字符串与 sv 进行比较，如同通过 std::basic_string_view<CharT, Traits>(*this).substr(pos1, count1).compare(sv)；

9) 将此字符串的 [pos1, pos1 + count1) 子字符串与 sv 的子字符串 [pos2, pos2 + count2) 进行比较，如同通过 std::basic_string_view<CharT, Traits>(*this)
.substr(pos1, count1).compare(sv.substr(pos2, count2))。

这些重载仅在 std::is_convertible_v<const StringViewLike&,
std::basic_string_view<CharT, Traits>> 为 true 且 std::is_convertible_v<const StringViewLike&, const CharT*> 为 false 时才参与重载决议。

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

首先，计算要比较的字符数，如同通过 size_type rlen = std::min(count1, count2)。
然后通过调用 Traits::compare(data1, data2, rlen) 比较序列。对于标准字符串，此函数执行逐字符的字典序比较。如果结果为零（到目前为止字符序列相等），则按如下方式比较它们的大小：

条件		结果	返回值
`Traits::compare(data1, data2, rlen) < 0`		data1 小于 data2	<0
`Traits::compare(data1, data2, rlen) == 0`	size1 < size2	data1 小于 data2	<0
	size1 == size2	data1 等于 data2	0
	size1 > size2	data1 大于 data2	>0
`Traits::compare(data1, data2, rlen) > 0`		data1 大于 data2	>0

str	-	要比较的另一个字符串
s	-	指向要比较的字符字符串的指针
count1	-	此字符串要比较的字符数
pos1	-	此字符串中要比较的第一个字符的位置
count2	-	给定字符串要比较的字符数
pos2	-	给定字符串中要比较的第一个字符的位置
t	-	要比较的对象（可转换为 std::basic_string_view）

[编辑] 返回值

如果 *this 在字典序中出现在参数指定的字符序列之前，则返回负值。
如果两个字符序列比较等价，则返回零。
如果 *this 在字典序中出现在参数指定的字符序列之后，则返回正值。

[编辑] 异常

接受名为 pos1 或 pos2 的参数的重载，如果参数超出范围，则抛出 std::out_of_range。

7)

noexcept 规范：

noexcept(std::is_nothrow_convertible_v<const T&, std::basic_string_view<CharT, Traits>>)

8,9) 抛出转换为 std::basic_string_view 抛出的任何异常。

如果由于任何原因抛出异常，此函数无效果（强异常安全保证）。

[编辑] 可能的实现

重载 (1)

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 with other string
    compare_result = batman.compare(superman);
    std::cout << "1) ";
    print_compare_result("Batman", "Superman", compare_result);
 
    // 2) Compare substring with other string
    compare_result = batman.compare(3, 3, superman);
    std::cout << "2) ";
    print_compare_result("man", "Superman", compare_result);
 
    // 3) Compare substring with other substring
    compare_result = batman.compare(3, 3, superman, 5, 3);
    std::cout << "3) ";
    print_compare_result("man", "man", compare_result);
 
    // Compare substring with other substring
    // defaulting to end of other string
    assert(compare_result == batman.compare(3, 3, superman, 5));
 
    // 4) Compare with char pointer
    compare_result = batman.compare("Superman");
    std::cout << "4) ";
    print_compare_result("Batman", "Superman", compare_result);
 
    // 5) Compare substring with char pointer
    compare_result = batman.compare(3, 3, "Superman");
    std::cout << "5) ";
    print_compare_result("man", "Superman", compare_result);
 
    // 6) Compare substring with char pointer substring
    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++ 标准。

缺陷报告	应用于	发布时的行为	正确的行为
LWG 5	C++98	重载 (6) 的参数 count2 有一个默认参数 npos	默认参数已移除，拆分为重载 (5) 和 (6)
LWG 847	C++98	没有异常安全保证	添加了强异常安全保证
LWG 2946	C++17	重载 (7) 在某些情况下导致歧义	通过使其成为模板来避免
P1148R0	C++17	重载 (7) 的 noexcept 意外地被 LWG2946 的解决方案删除了 dropped by the resolution of LWG2946	恢复

[编辑] 另请参阅

operator==operator!=operator<operator>operator<=operator>=operator<=> (C++20 中移除)(C++20 中移除)(C++20 中移除)(C++20 中移除)(C++20 中移除)(C++20)	按字典序比较两个字符串 (函数模板) [编辑]
substr	返回子字符串 (公共成员函数) [编辑]
collate	定义字符串的词法比较和哈希 (类模板) [编辑]
strcoll	根据当前区域设置比较两个字符串 (函数) [编辑]
lexicographical_compare	如果一个范围在字典上小于另一个范围，则返回 true (函数模板) [编辑]
compare	比较两个视图 (`std::basic_string_view<CharT,Traits>` 的公共成员函数) [编辑]

编译器支持
自由（freestanding）与宿主（hosted）
语言
标准库
标准库头文件
具名要求
特性测试宏 (C++20)
语言支持库
概念库 (C++20)
诊断库
内存管理库
元编程库 (C++11)
通用工具库
容器库
迭代器库
范围库 (C++20)
算法库
字符串库
文本处理库
数值库
日期和时间库
输入/输出库
文件系统库 (C++17)
并发支持库 (C++11)
执行控制库 (C++26)
技术规范
符号索引
外部库

cppreference.cn

命名空间

变体

视图

操作