operator==(std::common_iterator)

template <class I2, std::sentinel_for<I> S2>
    requires std::sentinel_for<S, I2>
friend constexpr bool operator==( const common_iterator& x, 
                                  const std::common_iterator<I2, S2>& y );

(1)

(since C++20)

template <class I2, std::sentinel_for<I> S2>
    requires std::sentinel_for<S, I2> && std::equality_comparable_with<I, I2>
friend constexpr bool operator==( const common_iterator& x, 
                                  const std::common_iterator<I2, S2>& y );

(2)

(since C++20)

Сравнивает итераторы и/или сентинелы, хранящиеся в базовых объектах-членах std::variant var . Два несравнимых итератора или два сентинела считаются равными.

Пусть Ix — x.var.index(), а Iy — y.var.index():

1) Если Ix == Iy (то есть оба x и y хранят итераторы или оба хранят сентинелы), возвращает true, в противном случае возвращает std::get<Ix>(x.var) == std::get<Iy>(y.var).

2) Если Ix == 1 && Iy == 1 (то есть оба x и y хранят сентинелы), возвращает true, в противном случае возвращает std::get<Ix>(x.var) == std::get<Iy>(y.var).

Если x.var.valueless_by_exception() || y.var.valueless_by_exception() является true, поведение не определено.

(до C++26)

Если x.var.valueless_by_exception() || y.var.valueless_by_exception() является true:

Если реализация защищена, происходит нарушение контракта.
Если реализация не защищена, поведение не определено.

(начиная с C++26)

Оператор != синтезируется из operator==.

Эти шаблоны функций не видны при обычном неквалифицированном или квалифицированном поиске и могут быть найдены только с помощью поиска, зависящего от аргументов, если std::common_iterator<I> является ассоциированным классом аргументов.

Параметры

x, y

адаптеры итераторов для сравнения

Возвращаемое значение

true, если базовые итераторы и/или сентинелы равны, в противном случае false.

Пример

#include <cassert>
#include <iterator>

int main()
{
    int a[]{0, 1, 2, 3};
    
    using CI = std::common_iterator<std::counted_iterator<int*>,
                                    std::default_sentinel_t>;
    
    CI i1{std::counted_iterator{a + 0, 2}};
    CI i2{std::counted_iterator{a + 1, 2}};
    CI i3{std::counted_iterator{a + 0, 3}};
    CI i4{std::counted_iterator{a + 0, 0}};
    CI s1{std::default_sentinel};
    CI s2{std::default_sentinel};
    
    assert((i1 == i2) == true);
    assert((i1 == i3) == false);
    assert((i2 == i3) == false);
    assert((s1 == s2) == true);
    assert((i1 == s1) == false);
    assert((i4 == s1) == true);
}

Отчёты об ошибках

Следующие отчёты об ошибках, изменяющие поведение, были ретроспективно применены к ранее опубликованным стандартам C++.

Отчёт об ошибке	Применяется к	Опубликованное поведение	Корректное поведение
LWG 3574	C++20	`variant` полностью поддерживал constexpr (P2231R1), а `common_iterator` — нет	также сделан constexpr

См. также

operator-

(C++20)

вычисляет расстояние между двумя адаптерами итераторов
(шаблон функции)

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/cpp/iterator/common_iterator/operator_cmp