iterator Класс

Класс QMultiHash::iterator предоставляет итератор в стиле STL для QMultiHash. Подробнее...

• Список всех членов, включая унаследованные

Открытые функции

Подробное описание

QMultiHash содержит как итераторы в стиле STL, так и итераторы в стиле Java. Итераторы в стиле STL более низкого уровня и сложнее в использовании; с другой стороны, они немного быстрее, и для разработчиков, уже знакомых со STL, имеют преимущество в виде привычности.

QMultiHash<Key, T>::iterator позволяет итерироваться по QMultiHash и изменять значение (но не ключ), связанное с определённым ключом. Если вы хотите итерироваться по константному QMultiHash, используйте QMultiHash::const_iterator. В общем случае рекомендуется использовать QMultiHash::const_iterator для неконстантного QMultiHash, если только вы не нуждаетесь в изменении QMultiHash через итератор. Константные итераторы немного быстрее и могут улучшить удобочитаемость кода.

Конструктор QMultiHash::iterator по умолчанию создаёт неинициализированный итератор. Вы должны инициализировать его с помощью функции QMultiHash, например, QMultiHash::begin(), QMultiHash::end() или QMultiHash::find(), прежде чем начать итерацию. Вот типичный цикл, который выводит все пары (ключ, значение) хранящиеся в хеш-таблице:

QHash<QString, int> hash;
hash.insert("January", 1);
hash.insert("February", 2);
...
hash.insert("December", 12);

QHash<QString, int>::iterator i;
for (i = hash.begin(); i != hash.end(); ++i)
    cout << i.key() << ": " << i.value() << Qt::endl;

В отличие от QMap, который упорядочивает свои элементы по ключу, QMultiHash хранит свои элементы в произвольном порядке.

Давайте посмотрим несколько примеров того, что можно сделать с QMultiHash::iterator, но нельзя сделать с QMultiHash::const_iterator. Вот пример, который увеличивает каждое значение, хранящееся в QMultiHash, на 2:

QHash<QString, int>::iterator i;
for (i = hash.begin(); i != hash.end(); ++i)
    i.value() += 2;

Вот пример, который удаляет все элементы, ключ которых является строкой, начинающейся с символа подчёркивания:

QHash<QString, int>::iterator i = hash.begin();
while (i != hash.end()) {
    if (i.key().startsWith('_'))
        i = hash.erase(i);
    else
        ++i;
}

Вызов QMultiHash::erase() удаляет элемент, на который указывает итератор, из хеш-таблицы и возвращает итератор на следующий элемент. Вот ещё один способ удаления элемента во время итерации:

QHash<QString, int>::iterator i = hash.begin();
while (i != hash.end()) {
    QHash<QString, int>::iterator prev = i;
    ++i;
    if (prev.key().startsWith('_'))
        hash.erase(prev);
}

Может показаться заманчивым написать код такого вида:

// WRONG
while (i != hash.end()) {
    if (i.key().startsWith('_'))
        hash.erase(i);
    ++i;
}

Однако это потенциально приведёт к сбою в ++i, потому что i является висящим итератором после вызова erase().

Можно использовать несколько итераторов в одной и той же хеш-таблице. Однако имейте в виду, что любые изменения, произведённые непосредственно в QHash (вставка и удаление элементов), могут привести к тому, что итераторы станут недействительными.

Вставка элементов в хеш-таблицу или вызов методов, таких как QHash::reserve() или QHash::squeeze(), может привести к тому, что все итераторы, указывающие на хеш-таблицу, станут недействительными. Итераторы гарантированы оставаться действительными только до тех пор, пока QHash не вынуждена увеличивать/уменьшать свою внутреннюю хеш-таблицу. Использование любого итератора после того, как произошла перехешировка, приведёт к неопределённому поведению.

Однако вы можете безопасно использовать итераторы для удаления записей из хеш-таблицы с помощью метода QHash::erase(). Этот метод можно безопасно вызывать во время итерации, и он не повлияет на порядок элементов в хеш-таблице.

Если вам нужно хранить итераторы в течение длительного времени, мы рекомендуем использовать QMultiMap вместо QHash.

См. также QMultiHash::const_iterator, QMultiHash::key_iterator и QMutableHashIterator.

Документация по членам-функциям

Возвращает true если other указывает на другой элемент, чем этот итератор; в противном случае возвращает false.

См. также operator==().

Возвращает true если other указывает на тот же элемент, что и этот итератор; в противном случае возвращает false.

См. также operator!=().

iterator::iterator()

Создаёт неинициализированный итератор.

Функции, такие как key(), value() и operator++(), не должны вызываться на неинициализированном итераторе. Используйте operator=() для присваивания значения перед его использованием.

См. также QMultiHash::begin() и QMultiHash::end().

const Key &iterator::key() const

Возвращает ключ текущего элемента в виде константной ссылки.

Нет прямого способа изменить ключ элемента через итератор, хотя это можно сделать, вызвав QMultiHash::erase() и затем QMultiHash::insert().

См. также value().

T &iterator::value() const

Возвращает изменяемую ссылку на значение текущего элемента.

Вы можете изменить значение элемента, используя value() в левой части присваивания, например:

if (i.key() == "Hello")
    i.value() = "Bonjour";

См. также key() и operator*().

T &iterator::operator*() const

Возвращает изменяемую ссылку на значение текущего элемента.

То же самое, что и value().

См. также key().

iterator &iterator::operator++()

Префиксный оператор ++ (++i) сдвигает итератор к следующему элементу в хеш-таблице и возвращает итератор на новый текущий элемент.

Вызов этой функции для QMultiHash::end() приведёт к неопределённым результатам.

iterator iterator::operator++(int)

Это перегруженная функция.

Постфиксный оператор ++ (i++) сдвигает итератор к следующему элементу в хеш-таблице и возвращает итератор на предыдущий текущий элемент.

T *iterator::operator->() const

Возвращает указатель на значение текущего элемента.

См. также value().