std::sub_match::compare

 

C++

Language

Headers

Freestanding and hosted implementations

Named requirements

Language support library

Concepts library (C++20)

Diagnostics library

Utilities library

Strings library

Containers library

Algorithms library

Iterators library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

Filesystem library (C++17)

Technical Specifications

 

Regular expressions library

Classes

basic_regex (C++11)

sub_match (C++11)

match_results (C++11)

Algorithms

regex_match (C++11)

regex_search (C++11)

regex_replace (C++11)

Iterators

regex_iterator (C++11)

regex_token_iterator (C++11)

Exceptions

regex_error (C++11)

Traits

regex_traits (C++11)

Constants

syntax_option_type (C++11)

match_flag_type (C++11)

error_type (C++11)

Regex Grammar

Modified ECMAScript-262 (C++11)

 

std::sub_match

Member functions

sub_match::sub_match

sub_match::length

sub_match::strsub_match::operator string_type

sub_match::compare

Non-member functions

operator==operator!=operator<<operator<=operator>operator>=

operator<<

 

int compare( const sub_match& m ) const;	(1)	(since C++11)
int compare( const string_type& s ) const;	(2)	(since C++11)
int compare( const value_type* c ) const;	(3)	(since C++11)

1) Compares two sub_match directly by comparing their underlying character sequences. Equivalent to str().compare(m.str()).

2) Compares a sub_match with a std::basic_string. Equivalent to str().compare(s).

3) Compares a sub_match with a null-terminated sequence of the underlying character type pointed to by s. Equivalent to str().compare(c).

This function is infrequently used directly by application code. Instead, one of the non-member comparison operators are used.

Parameters

m	-	a reference to another sub_match
s	-	a reference to a string to compare to
c	-	a pointer to a null-terminated character sequence of the underlying value_type to compare to

Return value

A value less than zero if this sub_match is less than the other character sequence, zero if the both underlying character sequences are equal, greater than zero if this sub_match is greater than the other character sequence.

See also

compare	compares two strings (public member function of std::basic_string)
stroperator string_type	converts to the underlying string type (public member function)
operator==operator!=operator<operator<=operator>operator>=	compares two sub_match objects (function template)