std::sub_match - Man Page

std::sub_match< _BiIter >

Synopsis

Inherits std::pair< _BiIter, _BiIter >.

Public Types

typedef __iter_traits::difference_type difference_type
typedef _BiIter first_type
The type of the first member.
typedef _BiIter iterator
typedef _BiIter second_type
The type of the second member.
typedef basic_string< value_type > string_type
typedef __iter_traits::value_type value_type

Public Member Functions

int compare (const sub_match &__s) const
Compares this and another matched sequence.
difference_type length () const noexcept
Gets the length of the matching sequence.
operator string_type () const
Gets the matching sequence as a string.
string_type str () const
Gets the matching sequence as a string.
constexpr void swap (pair &__p) noexcept(__and_< __is_nothrow_swappable< _BiIter >, __is_nothrow_swappable< _BiIter >>::value)
Swap the first members and then the second members.

int compare (const string_type &__s) const
Compares this sub_match to a string.
int compare (const value_type *__s) const
Compares this sub_match to a string.

Public Attributes

_BiIter first
The first member.
bool matched
_BiIter second
The second member.

Detailed Description

template<typename _BiIter>

class std::sub_match< _BiIter >" A sequence of characters matched by a particular marked sub-expression.

An object of this class is essentially a pair of iterators marking a matched subexpression within a regular expression pattern match. Such objects can be converted to and compared with std::basic_string objects of a similar base character type as the pattern matched by the regular expression.

The iterators that make up the pair are the usual half-open interval referencing the actual original pattern matched.

Definition at line 869 of file regex.h.

Member Typedef Documentation

typedef _BiIter  std::pair< _BiIter , _BiIter  >::first_type [inherited]

The type of the first member.

Definition at line 214 of file stl_pair.h.

typedef _BiIter  std::pair< _BiIter , _BiIter  >::second_type [inherited]

The type of the second member.

Definition at line 215 of file stl_pair.h.

Member Function Documentation

template<typename _BiIter > int std::sub_match< _BiIter >::compare (const string_type & __s) const [inline]

Compares this sub_match to a string.

Parameters

__s A string to compare to this sub_match.

Return values

negative This matched sequence will collate before __s.
zero This matched sequence is equivalent to __s.
positive This matched sequence will collate after __s.

Definition at line 938 of file regex.h.

template<typename _BiIter > int std::sub_match< _BiIter >::compare (const sub_match< _BiIter > & __s) const [inline]

Compares this and another matched sequence.

Parameters

__s Another matched sequence to compare to this one.

Return values

negative This matched sequence will collate before __s.
zero This matched sequence is equivalent to __s.
positive This matched sequence will collate after __s.

Definition at line 924 of file regex.h.

Referenced by std::sub_match< _BiIter >::operator!=(), std::sub_match< _BiIter >::operator<(), std::sub_match< _BiIter >::operator<=(), std::sub_match< _BiIter >::operator==(), std::sub_match< _BiIter >::operator>(), and std::sub_match< _BiIter >::operator>=().

template<typename _BiIter > int std::sub_match< _BiIter >::compare (const value_type * __s) const [inline]

Compares this sub_match to a string.

Parameters

__s A string to compare to this sub_match.

Return values

negative This matched sequence will collate before __s.
zero This matched sequence is equivalent to __s.
positive This matched sequence will collate after __s.

Definition at line 942 of file regex.h.

template<typename _BiIter > difference_type std::sub_match< _BiIter >::length () const [inline], [noexcept]

Gets the length of the matching sequence.

Definition at line 885 of file regex.h.

References std::pair< _BiIter, _BiIter >::first, and std::pair< _BiIter, _BiIter >::second.

template<typename _BiIter > std::sub_match< _BiIter >::operator string_type () const [inline]

Gets the matching sequence as a string.

Returns

the matching sequence as a string.

This is the implicit conversion operator. It is identical to the str() member function except that it will want to pop up in unexpected places and cause a great deal of confusion and cursing from the unwary.

Definition at line 898 of file regex.h.

References std::sub_match< _BiIter >::str().

template<typename _BiIter > string_type std::sub_match< _BiIter >::str () const [inline]

Gets the matching sequence as a string.

Returns

the matching sequence as a string.

Definition at line 907 of file regex.h.

References std::pair< _BiIter, _BiIter >::first, and std::pair< _BiIter, _BiIter >::second.

Referenced by std::sub_match< _BiIter >::operator string_type().

constexpr void std::pair< _BiIter , _BiIter  >::swap (pair< _BiIter, _BiIter > & __p) [inline], [constexpr], [noexcept], [inherited]

Swap the first members and then the second members.

Definition at line 439 of file stl_pair.h.

Member Data Documentation

_BiIter  std::pair< _BiIter , _BiIter  >::first [inherited]

The first member.

Definition at line 217 of file stl_pair.h.

_BiIter  std::pair< _BiIter , _BiIter  >::second [inherited]

The second member.

Definition at line 218 of file stl_pair.h.

Author

Generated automatically by Doxygen for libstdc++ from the source code.

Info

Wed Apr 28 2021 libstdc++