Контейнерные классыВведениеБиблиотека Qt предоставляет набор контейнерных классов общего назначения основанных на шаблонах. Эти классы могут использоваться для хранения элементов определенного типа. Например, если вам необходим массив изменяемого размера, содержащий QString, используйте QVector<QString>. Эти контейнерные классы разработаны для легкого, безопасного и простого использования вместо контейнеров STL. Если вы не знакомы с STL, или предпочитаете работать "только с Qt", то можете использовать эти классы вместо классов STL. Контейнерные классы - классы с неявным совместным использованием данных, они реентерабельны, и они оптимизированы для быстрой работы, низкого потребления памяти и минимального увеличения кода (inline), результат в меньшем исполняемом файле. Кроме того, они потоко-безопасны в ситуациях, где они используются, как контейнеры только для чтения, всеми потоками используемыми для доступа к ним. Для обхода элементов, хранящихся в контейнере, вы можете использовать один из двух типов итераторов: итераторы в стиле Java и итераторы в стиле STL. Итераторы в стиле Java легче использовать и они предоставляют высокоуровневую функциональность, тогда как итераторы в стиле STL немного более эффективны и могут быть использованы вместе с базовыми алгоритмами Qt и STL. Qt также предоставляет конструкцию foreach, которая позволяет очень легко перебрать все элементы, хранящиеся в контейнере. Контейнерные классыQt предоставляет следующие последовательные контейнеры: QList, QLinkedList, QVector, QStack и QQueue. В большинстве приложений лучше всего использовать QList. Класс реализован в виде списка-массива, что позволяет быстро добавлять в начало и в конец. Если вам нужен настоящий связанный список, то используйте QLinkedList; если вы хотите размещать записи в памяти рядом, обратите внимание на QVector. QStack и QQueue - вспомогательные классы, предоставляющие семантику FIFO и LIFO. Qt также предоставляет такие ассоциативные контейнеры: QMap, QMultiMap, QHash, QMultiHash и QSet. "Multi" контейнеры поддерживают ассоциирование нескольких значений с одним ключом. "Hash" контейнеры предоставляют быстрый доступ с использованием хэш-функции для бинарного поиска в отсортированном наборе. В качестве частных случаев, классы QCache и QContiguousCache предоставляют эффективный просмотр с хэшированием объектов в ограниченном хранилище кэша.
Контейнеры могут быть вложенными. Например, вполне возможно использовать QMap<QString, QList<int> >, где типом ключа является QString, а типом значения - QList<int>. Единственный нюанс - это то, что вы должны оставить пространство между закрывающими угловыми скобками (>); иначе, компилятор C++ воспримет два символа > как оператор сдвига вправо (>>) и сообщит об ошибке. Контейнеры определены в индивидуальных заголовочных файлах с тем же именем, что и контейнер (например, <QLinkedList>). Для удобства, контейнеры объявлены в <QtContainerFwd>. Значения, хранящиеся в различных контейнерах, могут быть любого присваиваемого типа данных. Для этого тип должен предоставлять конструктор по умолчанию, конструктор копирования и оператор присваивания. Это охватывает большинство типов данных, которые вы, вероятно, захотите поместить в контейнер, включая базовые типы, такие как int и double, типы указателей и типы данных Qt, такие как QString, QDate и QTime, но не охватывает типы QObject или любые из подклассов QObject (QWidget, QDialog, QTimer, и т.д.). Если вы попытаетесь создать экземпляр QList<QWidget>, компилятор сообщит, что конструктор копирования и операторы присваивания QWidget запрещены. Если вы хотите поместить эти виды объектов в контейнер, то поместите указатели на них, например, так QList<QWidget *> Вот пример пользовательского типа данных, который отвечает требованием присваиваемого типа данных: class Employee { public: Employee() {} Employee(const Employee &other); Employee &operator=(const Employee &other); private: QString myName; QDate myDateOfBirth; }; Если вы не предоставляете конструктор копирования или оператор присваивания, C++ предоставляет реализацию по умолчанию, которая выполняет копирование объекта почленно. Определение класса в вышеприведенном примере достаточно. Также, если вы не предоставляете никаких конструкторов, то C++ предоставляет конструктор по умолчанию, который инициализирует члены класса используя их конструкторы по умолчанию. Следующий тип данных может быть помещен в контейнер, несмотря на то, что он не предоставляет явно никаких конструкторов и оператора присваивания: struct Movie { int id; QString title; QDate releaseDate; }; Некоторые контейнеры предъявляют дополнительные требования к типам данных, которые они могут хранить. Например, тип Key контейнера QMap<Key, T> должен предоставить operator<(). Такие особые требования документированы в подробном описании классов. В некоторых случаях, определенные функции предъявляют специальные требования; они указаны в описаниях функций. Если эти требования не выполняются, компилятор всегда будет генерировать ошибку Контейнеры Qt предоставляют operator<<() и operator>>(), и, поэтому, они могут быть легко прочитаны и записаны используя QDataStream. Это означает, что типы данных, помещаемых в контейнер, также должны поддерживать operator<<() и operator>>(). Предоставление такой поддержки просто; вот как мы могли бы сделать ее для структуры Movie приведенной выше: QDataStream &operator<<(QDataStream &out, const Movie &movie) { out << (quint32)movie.id << movie.title << movie.releaseDate; return out; } QDataStream &operator>>(QDataStream &in, Movie &movie) { quint32 id; QDate date; in >> id >> movie.title >> date; movie.id = (int)id; movie.releaseDate = date; return in; } Документация некоторых функций классов-контейнеров ссылается на значения конструируемые по умолчанию; например, QVector автоматически инициализирует свои элементы значениями по умолчанию, а QMap::value() возвращает значение по умолчанию, если указанный ключ отсутствует в словаре. Для большинства типов значений это просто означает, что они созданы используя конструктор по умолчанию (например, пустая строка для QString). Но для примитивных типов, подобных int и double, как и для типов указателей, язык C++ не предусматривает никакой инициализации; в этих случаях, контейнеры Qt автоматически инициализируют значения нулем. Классы-итераторыИтераторы предоставляют одинаковые средства доступа к элементам контейнера. Классы контейнеров Qt предоставляют два типа итераторов: итераторы в стиле Java и итераторы в стиле STL. Итераторы обоих типов становятся недействительными, когда данные в контейнере модифицированы или отделены от неявно разделяемых копий ожидаемого для вызова неконстантной функции-члена. Итераторы в стиле JavaИтераторы в стиле Java являются новыми в Qt 4 и являются стандартными, используемыми в приложениях Qt. Они более удобны в использовании, чем итераторы в стиле STL, но они немного менее эффективны. Их API сделан по образцу классов-итераторов Java. Для каждого класса-контейнера определено два типа итераторов в стиле Java: один из них предоставляет доступ только для чтения, а другой предоставляет доступ для чтения-записи.
В этом обсуждении мы сконцентрируемся на QList и QMap. Типы итераторов для QLinkedList, QVector и QSet имеют точно такой же интерфейс, что и итераторы QList; аналогично, типы итераторов для QHash имеют тот же интерфейс, что и итераторы QMap. В отличие от итераторов в стиле STL (рассматриваемых ниже), итераторы в стиле Java указывают на ячейку памяти между элементами, а не на сами элементы. Поэтому они указывают либо на начало контейнера (перед первым элементом), либо на конец контейнера (после последнего элемента), либо между двумя элементами. На диаграмме ниже красными стрелками показаны возможные позиции итератора в списке, содержащем четыре элемента: Вот типичный пример цикла для перебора всех элементов QList<QString> по порядку и вывода их в консоль: QList<QString> list; list << "A" << "B" << "C" << "D"; QListIterator<QString> i(list); while (i.hasNext()) qDebug() << i.next(); Он работает следующим образом: чтобы перебрать элементы, QList помещается в конструктор QListIterator. В этот момент итератор позиционирован на начало первого элемента в списке (перед элементом "A"). Потом мы вызываем hasNext() для проверки, существует ли какой-либо элемент после позиции итератора. Если есть, то мы вызываем next(), чтобы перепрыгнуть через него. Функция next() возвращает элемент, через который перепрыгнул итератор. Для QList<QString> - это элемент типа QString. Вот как перебрать элементы QList в обратном порядке: QListIterator<QString> i(list); i.toBack(); while (i.hasPrevious()) qDebug() << i.previous(); Этот код симметричен перебору в прямом порядке, за исключения того, что мы начинаем с вызова toBack() для перемещения итератора на позицию, после последнего элемента в списке. Диаграмма, приведенная ниже, показывает эффект от вызовов функций итератора next() и previous(): В следующей таблице подводится итог API QListIterator:
QListIterator не предоставляет функций для вставки или удаления элементов перебираемого списка. Для того, чтобы сделать это, вы должны использовать QMutableListIterator. Вот пример, где мы удаляем все элементы с нечетными значениями из QList<int> используя QMutableListIterator: QMutableListIterator<int> i(list); while (i.hasNext()) { if (i.next() % 2 != 0) i.remove(); } Вызов next() осуществляется в каждой итерации цикла. Он перепрыгивает через следующий элемент в списке. Функция remove() удаляет последний элемент, через который мы перепрыгнули в списке. Вызов remove() не делает итератор недействительным, и он остается пригодным для дальнейшего использования. Это работает точно также и при переборе элементов в обратном порядке: QMutableListIterator<int> i(list); i.toBack(); while (i.hasPrevious()) { if (i.previous() % 2 != 0) i.remove(); } Если вы желаете лишь изменить значение существующего элемента, то можете использовать функцию setValue(). В коде ниже, мы заменяем любое значение большее чем 128, на 128: QMutableListIterator<int> i(list); while (i.hasNext()) { if (i.next() > 128) i.setValue(128); } Точно также, как и remove(), setValue() работает с последнем элементом, который мы перепрыгнули. Если вы перебираете элементы в прямом направлении, то это элемент, расположенный прямо перед итератором, если вы перебираете элементы в обратном порядке, то это элемент, расположенный сразу за итератором. Функция next() возвращает неконстантную ссылку на элемент списка. Для простых операций нам даже не требуется setValue(): QMutableListIterator<int> i(list); while (i.hasNext()) i.next() *= 2; Как было сказано выше, итераторы классов QLinkedList, QVector и QSet имеют совершенно такой же API как и у QList. Теперь обратимся к QMapIterator, который несколько отличен, так как служит для перебора пар (ключ, значение). Как и QListIterator, QMapIterator предоставляет toFront(), toBack(), hasNext(), next(), peekNext(), hasPrevious(), previous() и peekPrevious(). Компоненты ключ и значение могут быть получены вызовом key() и value() для объекта, возвращенного next(), peekNext(), previous() или peekPrevious(). В следующем примере удаляются все пары (столица, государство), в которых название столицы оканчивается на "City": QMap<QString, QString> map; map.insert("Paris", "France"); map.insert("Guatemala City", "Guatemala"); map.insert("Mexico City", "Mexico"); map.insert("Moscow", "Russia"); ... QMutableMapIterator<QString, QString> i(map); while (i.hasNext()) { if (i.next().key().endsWith("City")) i.remove(); } QMapIterator также предоставляет функции key() и value(), которые работают напрямую с итератором и возвращают ключ и значение последнего элемента, который перепрыгнул итератор. Например, в следующем коде производится копирование содержимого QMap в QHash: QMap<int, QWidget *> map; QHash<int, QWidget *> hash; QMapIterator<int, QWidget *> i(map); while (i.hasNext()) { i.next(); hash.insert(i.key(), i.value()); } Если мы хотим перебрать все элементы, содержащие одно и то же значение, то мы можем использовать findNext() или findPrevious(). Вот пример, где мы удаляем все элементы с заданным значением: QMutableMapIterator<int, QWidget *> i(map); while (i.findNext(widget)) i.remove(); Итераторы в стиле STLИтераторы в стиле STL стали доступны, начиная с версии Qt 2.0. Они совместимы с базовыми алгоритмами Qt и STL и оптимизированы по скорости. Для каждого контейнерного класса есть два типа итераторов в стиле STL: один из них предоставляет доступ только для чтения, а другой - доступ для чтения-записи. Итераторы только для чтения должны использоваться везде, где это только возможно, так как они быстрее, чем итераторы для чтения-записи.
API итераторов в стиле STL сделан по образцу указателей в массиве. Например, оператор ++ перемещает итератор к следующему элементу, а оператор * возвращает элемент, на который позиционирован итератор. Фактически, для QVector и QStack, хранящих свои элементы в смежных ячейках памяти, тип iterator - это всего лишь typedef для T *, а тип const_iterator - всего лишь typedef для const T *. В этом обсуждении мы сконцентрируемся на QList и QMap. Типы итераторов для QLinkedList, QVector и QSet имеют точно такой же интерфейс, что и итераторы QList; аналогично, типы итераторов для QHash имеют тот же интерфейс, что и итераторы QMap. Вот типичный пример цикла для перебора всех элементов QList<QString> по порядку и конвертирования их в нижний регистр: QList<QString> list; list << "A" << "B" << "C" << "D"; QList<QString>::iterator i; for (i = list.begin(); i != list.end(); ++i) *i = (*i).toLower(); В отличие от итераторов в стиле Java, итераторы в стиле STL указывают непосредственно на элемент. Функция контейнера begin() возвращает итератор, указывающий на первый элемент контейнера. Функция контейнера end() возвращает итератор, указывающий на воображаемый элемент, находящийся в позиции, следующей за последним элементом контейнера. end() обозначает несуществующую позицию; он никогда не должен разыменовываться. Обычно, он используется, как условие выхода из цикла. Если список пуст, то begin() равен end(), поэтому цикл никогда не выполнится. На диаграмме ниже красными стрелками показаны возможные позиции итератора в списке, содержащем четыре элемента: При переборе элементов в обратном порядке с помощью итераторов в стиле STL, требуется, чтобы оператор декремента использовался перед обращения к элементу. Вот требуемый цикл while: QList<QString> list; list << "A" << "B" << "C" << "D"; QList<QString>::iterator i = list.end(); while (i != list.begin()) { --i; *i = (*i).toLower(); } В этих фрагментах кода, мы использовали унарный оператор * для восстановления значения элемента (типа QString), хранящегося в некоторой позиции итератора, а затем для него вызывали QString::toLower(). Большинство компиляторов C++ (но не все) также позволяют писать i->toLower()(). Для доступа к элементам только для чтения, можно использовать const_iterator, constBegin() и constEnd(). Например: QList<QString>::const_iterator i; for (i = list.constBegin(); i != list.constEnd(); ++i) qDebug() << *i; В следующей таблице подводится итог API итераторов в стиле STL:
Оба оператора ++ и -- могут использоваться и как префиксные (++i, --i) и как постфиксные (i++, i--) операторы. Префиксная версия изменяет итератор, и возвращает ссылку на измененный итератор; постфиксная версия, берет копию итератора перед его изменением, и возвращает эту копию. В выражениях, в которых возвращаемое значение игнорируется, мы рекомендуем использовать префиксную версию (++i, --i), так как она несколько быстрее. Для неконстантных итераторов, возвращаемое значение унарного оператора * может быть использовано с левой стороны от оператора присваивания. Для QMap и QHash, оператор * возвращает компонент значения элемента. Если вы хотите извлечь ключ, вызовите key() для итератора. Для симметрии, типы итераторов предоставляют также функцию value(), извлекающую значение. Например, здесь показано, как мы можем напечатать все элементы в QMap в консоль: QMap<int, int> map; ... QMap<int, int>::const_iterator i; for (i = map.constBegin(); i != map.constEnd(); ++i) qDebug() << i.key() << ":" << i.value(); Благодаря неявному совместному использованию данных, использование значений контейнера весьма недорого. API Qt содержит множество функций, возвращающих QList или QStringList со значениями (например, QSplitter::sizes()). Если вы хотите перебрать эти значения с помощью итератора в стиле STL, то вы всегда должны иметь копию контейнера и перебирать ее элементы. Например: // ПРАВИЛЬНО const QList<int> sizes = splitter->sizes(); QList<int>::const_iterator i; for (i = sizes.begin(); i != sizes.end(); ++i) ... // НЕПРАВИЛЬНО QList<int>::const_iterator i; for (i = splitter->sizes().begin(); i != splitter->sizes().end(); ++i) ... Эта проблема не должна возникать при использовании функций, которые возвращают константный или неконстантный указатель на контейнер. Неявное совместное использование данных имеет и другое влияние на использование итераторов в стиле STL: вы не должны делать копии контейнера, если для него активны неконстантные итераторы. Итераторы в стиле Java не страдают таким ограничением. Конструкция foreachЕсли вы хотите перебрать все элементы контейнера по порядку, то можете использовать конструкцию Qt foreach. Данная конструкция - это дополнение Qt к языку C++, реализованное с помощью средств препроцессора. Ее синтаксис: foreach (переменная, контейнер) оператор. В следующем примере показано использование конструкции foreach для перебора всех элементов контейнера QLinkedList<QString>: QLinkedList<QString> list; ... QString str; foreach (str, list) qDebug() << str; Код с конструкцией foreach значительно короче, чем аналогичный код, который использует итераторы: QLinkedList<QString> list; ... QLinkedListIterator<QString> i(list); while (i.hasNext()) qDebug() << i.next(); За исключением типа данных, содержащего запятую (например, QPair<int, int>), переменная, используемая для перебора элементов контейнера может быть определена внутри выражения foreach: QLinkedList<QString> list; ... foreach (const QString &str, list) qDebug() << str; И подобно любому циклу C++, вы можете заключить тело цикла foreach в фигурные скобки и использовать break для прерывания цикла: QLinkedList<QString> list; ... foreach (const QString &str, list) { if (str.isEmpty()) break; qDebug() << str; } При использовании с QMap и QHash, foreach предоставляет доступ к парам значений (key, value). Если вы хотите перебрать и ключи и значения, то можете использовать итераторы (которые быстрее) или написать код, подобный следующему: QMap<QString, int> map; ... foreach (const QString &str, map.keys()) qDebug() << str << ":" << map.value(str); Для многосвязных карт: QMultiMap<QString, int> map; ... foreach (const QString &str, map.uniqueKeys()) { foreach (int i, map.values(str)) qDebug() << str << ":" << i; } При входе в цикл foreach, Qt автоматически делает копию контейнера. Если вы измените контейнер во время выполнения цикла, то в цикле это не даст эффекта. (Если вы не изменяли контейнер, копирование все еще имеет место, но, благодаря неявному совместному использованию данных копирование контейнера осуществляется очень быстро.) Поскольку для каждой итерации создаётся копия контейнера, то использование неконстантной ссылки на перменную не позволит изменять исходный контейнер. Изменения подействуют только на копию, что, вероятно, отличается от ваших ожиданий. В дополнение к foreach, Qt также предоставляет псевдоключевое слово forever, для бесконечного цикла: forever { ... } Если вас беспокоит засорение пространства имен, то вы можете отключить использование этих макросов, добавив в .pro-файл следующую строку: CONFIG += no_keywords Другие контейнероподобные классыQt включает три класса-шаблона, которые в некотором отношении напоминают контейнеры. Эти классы не предоставляют итераторов и не могут использоваться в конструкции foreach.
Дополнительные нешаблонные типы, которые дополняют шаблонные контейнеры Qt, это - QBitArray, QByteArray, QString и QStringList. Алгоритмическая сложностьАлгоритмическая сложность заключаются в том, насколько быстро (или медленно) работает каждая из функций по мере того, как количество элементов в контейнере увеличивается. Например, вставка элемента в середину QLinkedList - чрезвычайно быстрая операция независимо от количества элементов хранящихся в QLinkedList. С другой стороны, вставка элемента в середину QVector, потенциально очень дорога, если QVector содержит много элементов, потому что половину элементов придется передвинуть на одну позицию в памяти. Чтобы описать алгоритмическую сложность мы используем следующую терминологию, основанную на нотации "большого O":
В следующей таблице приведён итог алгоритмической сложности последовательных контейнерных классов Qt:
В этой таблице, "Сред." обозначает "усредненное поведение" (amortized behavior). Например, "Сред. O(1)" обозначает, что, если вы вызовите функцию единожды, то можете получить поведение O(n), но если вы вызовете её множество раз (например, n раз), усредненная величина будет равна O(1). В следующей таблице приведён итог алгоритмической сложности ассоциативных контейнеров и наборов Qt:
В QVector, QHash и QSet, время выполнения усредняется до O(log n). Оно может быть сведено к O(1) с помощью вызова QVector::reserve(), QHash::reserve() или QSet::reserve(), с ожидаемым количеством элементов, до вставки элементов. В следующем разделе этот вопрос обсуждается более глубоко. Стратегии увеличения размераQVector<T>, QString и QByteArray хранят свои элементы в памяти непрерывно; QList<T> содержит массив указателей на элементы в хранилище, чтобы обеспечить быстрый доступ по индексу (если T не тип-указатель или базовый тип имеет размер указателя, в этом случае само значение хранится в массиве); QHash<Key, T> хранит хэш-таблицу, размер которой пропорционален количеству элементов в хэше. Во избежание перераспределения данных каждый раз при добавлении элемента в конец контейнера, эти классы обычно резервируют больше памяти, чем требуется. Рассмотрим следующий код, который собирает QString из другого QString: QString onlyLetters(const QString &in) { QString out; for (int j = 0; j < in.size(); ++j) { if (in[j].isLetter()) out += in[j]; } return out; } Мы собираем строку out динамически, добавляя в конец по одному символу за раз. Давайте предположим, что мы добавляем 15000 символов в строку QString. Тогда следующие 18 перераспределений данных (из возможных 15000) произойдут, когда QString исчерпает место под 4, 8, 12, 16, 20, 52, 116, 244, 500, 1012, 2036, 4084, 6132, 8180, 10228, 12276, 14324, 16372 символа. В конце концов QString будет иметь 16372 символов Unicode, из которых 15000 будут заняты. Значения выше могут показаться немного странными, но здесь руководящими принципами являются:
QByteArray и QList<T> используют более или менее похожие алгоритмы, как и QString. QVector<T> также использует этот алгоритм для типов данных, которые могут быть перемещены в памяти используя memcpy() (включая базовые типы C++, типы указателей и общие классы Qt), но для типов данных, которые могут быть перемещены только с помощью вызовов конструкторов копирования и деструкторов, использует другой алгоритм. Так как цена переразмещения в этом случае становится выше, QVector<T> уменьшает количество переразмещений, всегда удваивая память, когда исчерпает место. QHash<Key, T> - это совершенно другой случай. Внутренняя хэш-таблица QHash каждый раз увеличивается кратно степени двойки, элементы, переразмещеные в новой области памяти, вычисляются, как qHash(key) % QHash::capacity() (количество областей памяти). Это замечание также справедливо для QSet<T> и для QCache<Key, T>. Для большинства приложений, алгоритм увеличения размера по умолчанию, предоставляемый Qt, выполняется этот трюк. Если вам требуется большая управляемость, то QVector<T>, QHash<Key, T>, QSet<T>, QString и QByteArray предоставляют три функции, которые позволяют контролировать и задавать столько памяти, сколько вам нужно для размещения элементов:
Если вы приблизительно знаете сколько элементов вы разместите в контейнере, то вы можете начать с вызова reserve(), а затем, заполнив контейнер, вы можете вызвать squeeze() чтобы освободить дополнительно выделенную память. |
Попытка перевода Qt документации. Если есть желание присоединиться, или если есть замечания или пожелания, то заходите на форум: Перевод Qt документации на русский язык... Люди внесшие вклад в перевод: Команда переводчиков |