Класс QVarLengthArray

Класс QVarLengthArray предоставляет массив переменной длины низкого уровня. Подробнее...

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

Примечание: Все функции в этом классе являются повторно-входными.

Общедоступные типы

Общедоступные функции

Связанные нечлены

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

Язык C++ не поддерживает массивы переменной длины в стеке. Например, следующий код не будет компилироваться:

int myfunc(int n)
{
    int table[n + 1];  // WRONG
    ...
    return table[n];
}

Альтернативный вариант - выделение массива в куче (с new):

int myfunc(int n)
{
    int *table = new int[n + 1];
    ...
    int ret = table[n];
    delete[] table;
    return ret;
}

Однако, если myfunc() вызывается очень часто из внутреннего цикла приложения, выделение памяти в куче может стать значительной причиной замедления.

QVarLengthArray — это попытка обойти этот пробел в языке C++. Она выделяет определённое количество элементов в стеке, и если вы изменяете размер массива на больший размер, она автоматически использует кучу вместо стека. Выделение в стеке имеет преимущество, что это значительно быстрее, чем выделение в куче.

Пример:

int myfunc(int n)
{
    QVarLengthArray<int, 1024> array(n + 1);
    ...
    return array[n];
}

В примере выше QVarLengthArray предварительно выделит 1024 элемента в стеке и будет использовать их, пока n + 1 не будет больше 1024. Если вы опустите второй шаблонный аргумент, будет использовано значение по умолчанию QVarLengthArray, равное 256.

Тип значения QVarLengthArray должен быть присваиваемым типом данных. Это охватывает большинство типов данных, которые обычно используются, но компилятор не позволит вам, например, хранить QWidget в качестве значения; вместо этого храните указатель на QWidget.

QVarLengthArray, подобно QVector, обеспечивает структуру данных реsizable массив. Основные отличия между двумя классами:

• API QVarLengthArray намного более низкоуровневый и у него отсутствуют некоторые функции QVector.
• QVarLengthArray не инициализирует память, если значение является базовым типом. (QVector всегда делает это.)
• QVector использует неявное совместное использование в качестве оптимизации памяти. QVarLengthArray не предоставляет эту функцию; однако, обычно она обеспечивает немного лучшую производительность за счёт снижения накладных расходов, особенно в тесных циклах.

Подводя итог, QVarLengthArray — это низкоуровневый оптимизированный класс, который имеет смысл только в очень конкретных случаях. Он используется в нескольких местах внутри Qt и был добавлен в общедоступный API Qt для удобства продвинутых пользователей.

См. также QVector, QList и QLinkedList.

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

typedef QVarLengthArray::const_iterator

Тип для указателя const T *. Предоставляется для совместимости со STL.

Этот typedef был добавлен в Qt 4.7.

typedef QVarLengthArray::const_pointer

Тип для указателя const T *. Предоставляется для совместимости со STL.

Этот typedef был добавлен в Qt 4.7.

typedef QVarLengthArray::const_reference

Тип для const T &. Предоставляется для совместимости со STL.

Этот typedef был добавлен в Qt 4.7.

typedef QVarLengthArray::const_reverse_iterator

Тип для std::reverse_iterator<const T*>. Предоставляется для совместимости со STL.

Этот typedef был добавлен в Qt 5.6.

typedef QVarLengthArray::difference_type

Тип для ptrdiff_t. Предоставляется для совместимости со STL.

Этот typedef был добавлен в Qt 4.7.

typedef QVarLengthArray::iterator

Тип для указателя T *. Предоставляется для совместимости со STL.

Этот typedef был добавлен в Qt 4.7.

typedef QVarLengthArray::pointer

Тип для указателя T *. Предоставляется для совместимости со STL.

Этот typedef был добавлен в Qt 4.7.

typedef QVarLengthArray::reference

Тип для T &. Предоставляется для совместимости со STL.

Этот typedef был добавлен в Qt 4.7.

typedef QVarLengthArray::reverse_iterator

Тип для std::reverse_iterator<T*>. Предоставляется для совместимости со STL.

Этот typedef был добавлен в Qt 5.6.

typedef QVarLengthArray::size_type

Тип для int. Предоставляется для совместимости со STL.

Этот typedef был добавлен в Qt 4.7.

typedef QVarLengthArray::value_type

Тип для T. Предоставляется для совместимости со STL.

Этот typedef был добавлен в Qt 4.7.

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

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

Вставляет value перед элементом, на который указывает итератор before. Возвращает итератор, указывающий на вставленный элемент.

Эта документация была добавлена в Qt 4.8.

Вставляет value в позицию индекса i в массиве. Если i равно 0, значение добавляется в начало вектора. Если i равно size(), значение добавляется в конец вектора.

Для больших массивов эта операция может быть медленной (линейное время), так как она требует перемещения всех элементов с индексами i и выше на одну позицию дальше в памяти. Если вам нужен класс контейнера, обеспечивающий быструю функцию insert(), используйте QLinkedList вместо него.

Эта документация была добавлена в Qt 4.8.

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

Вставляет value в начало массива.

Это то же самое, что vector.insert(0, value).

Для больших массивов эта операция может быть медленной (линейное время), так как требует перемещения всех элементов вектора на одну позицию дальше в памяти. Если вам нужен класс контейнера, который предоставляет быструю функцию prepend(), используйте QList или QLinkedList вместо этого.

Данная документация была введена в Qt 4.8.

См. также append() и insert().

QVarLengthArray::QVarLengthArray(InputIterator first, InputIterator last)

Создает массив с содержимым в диапазоне итераторов [first, last).

Тип значения InputIterator должен быть преобразуем в T.

Эта функция была введена в Qt 5.14.

QVarLengthArray::QVarLengthArray(std::initializer_list<T> args)

Создает массив из переданного std::initializer_list args.

Этот конструктор доступен только если компилятор поддерживает C++11 initializer lists.

Эта функция была введена в Qt 5.5.

QVarLengthArray::QVarLengthArray(const QVarLengthArray<T, Prealloc> &other = ...)

Создает копию other.

QVarLengthArray::QVarLengthArray(int size)

Создает массив с начальным размером в size элементов.

Если тип значения — примитивный тип (например, char, int, float) или указатель (например, QWidget *), элементы не инициализируются. Для других типов элементы инициализируются с помощью значения по умолчанию.

QVarLengthArray<T, Prealloc> &QVarLengthArray::operator=(const QVarLengthArray<T, Prealloc> &other = ...)

Присваивает other этому массиву и возвращает ссылку на этот массив.

QVarLengthArray::~QVarLengthArray()

Удаляет массив.

void QVarLengthArray::append(const T &t)

Добавляет элемент t в массив, расширяя его при необходимости.

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

void QVarLengthArray::append(T &&t)

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

Примечание: В отличие от перегрузки append() для lvalue, передача ссылки на объект, который уже является элементом *this, приводит к неопределённому поведению:

vla.append(std::move(vla[0])); // BUG: passing an object that is already in the container

Эта функция была введена в Qt 5.9.

void QVarLengthArray::append(const T *buf, int size)

Добавляет size элементов, ссылающихся на buf, в этот массив.

const T &QVarLengthArray::at(int i) const

Возвращает ссылку на элемент по индексу i.

i должен быть корректным индексом в массиве (т.е., 0 <= i < size()).

См. также value() и operator[]().

T &QVarLengthArray::back()

То же самое, что и last(). Предоставлено для совместимости со STL.

Эта функция была введена в Qt 5.0.

const T &QVarLengthArray::back() const

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

Эта функция была введена в Qt 5.0.

QVarLengthArray::iterator QVarLengthArray::begin()

Возвращает итератор STL, указывающий на первый элемент массива.

Эта функция была введена в Qt 4.8.

См. также constBegin() и end().

QVarLengthArray::const_iterator QVarLengthArray::begin() const

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

Эта функция была введена в Qt 4.8.

int QVarLengthArray::capacity() const

Возвращает максимальное количество элементов, которое может храниться в массиве без принудительного перераспределения.

Единственная цель этой функции — предоставить способ точной настройки использования памяти QVarLengthArray. Как правило, вам редко понадобится вызывать эту функцию. Если вы хотите узнать, сколько элементов находится в массиве, вызовите size().

См. также reserve() и squeeze().

QVarLengthArray::const_iterator QVarLengthArray::cbegin() const

Возвращает постоянный итератор STL, указывающий на первый элемент массива.

Эта функция была введена в Qt 5.0.

См. также begin() и cend().

QVarLengthArray::const_iterator QVarLengthArray::cend() const

Возвращает постоянный итератор STL, указывающий на воображаемый элемент после последнего элемента в массиве.

Эта функция была введена в Qt 5.0.

См. также cbegin() и end().

void QVarLengthArray::clear()

Удаляет все элементы из массива.

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

QVarLengthArray::const_iterator QVarLengthArray::constBegin() const

Возвращает постоянный итератор STL, указывающий на первый элемент массива.

Эта функция была введена в Qt 4.8.

См. также begin() и constEnd().

const T *QVarLengthArray::constData() const

Возвращает постоянный указатель на данные, хранящиеся в массиве. Указатель может использоваться для доступа к элементам массива. Указатель остается действительным до тех пор, пока массив не перераспределён.

Функция полезна в основном для передачи массива функции, принимающей обычный массив C++.

См. также data() и operator[]().

QVarLengthArray::const_iterator QVarLengthArray::constEnd() const

Возвращает постоянный итератор STL, указывающий на воображаемый элемент после последнего элемента в массиве.

Эта функция была введена в Qt 4.8.

См. также constBegin() и end().

bool QVarLengthArray::contains(const T &value) const

Возвращает true если массив содержит вхождение value; в противном случае возвращает false.

Для этой функции требуется, чтобы тип значения имел реализацию operator==().

Эта функция была введена в Qt 5.3.

См. также indexOf() и lastIndexOf().

int QVarLengthArray::count() const

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

См. также isEmpty() и resize().

QVarLengthArray::const_reverse_iterator QVarLengthArray::crbegin() const

Возвращает постоянный обратный итератор STL, указывающий на первый элемент массива в обратном порядке.

Эта функция была введена в Qt 5.6.

См. также begin(), rbegin(), и rend().

QVarLengthArray::const_reverse_iterator QVarLengthArray::crend() const

Возвращает постоянный обратный итератор STL, указывающий на элемент после последнего элемента массива в обратном порядке.

Эта функция была введена в Qt 5.6.

См. также end(), rend(), и rbegin().

T *QVarLengthArray::data()

Возвращает указатель на данные, хранящиеся в массиве. Указатель может использоваться для доступа и изменения элементов массива.

Пример:

QVarLengthArray<int> array(10);
int *data = array.data();
for (int i = 0; i < 10; ++i)
    data[i] = 2 * i;

Указатель остается действительным до тех пор, пока массив не перераспределён.

Функция полезна в основном для передачи массива функции, принимающей обычный массив C++.

См. также constData() и operator[]().

const T *QVarLengthArray::data() const

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

bool QVarLengthArray::empty() const

Возвращает true если размер массива равен 0; в противном случае возвращает false.

То же самое, что и isEmpty(). Предоставлено для совместимости со STL.

Эта функция была добавлена в Qt 5.0.

QVarLengthArray::iterator QVarLengthArray::end()

Возвращает итератор STL, указывающий на воображаемый элемент после последнего элемента в массиве.

Эта функция была добавлена в Qt 4.8.

См. также begin() и constEnd().

QVarLengthArray::const_iterator QVarLengthArray::end() const

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

Эта функция была добавлена в Qt 4.8.

QVarLengthArray::iterator QVarLengthArray::erase(QVarLengthArray::const_iterator pos)

Удаляет элемент, на который указывает итератор pos из вектора и возвращает итератор на следующий элемент в векторе (который может быть end()).

Эта функция была добавлена в Qt 4.8.

См. также insert() и remove().

QVarLengthArray::iterator QVarLengthArray::erase(QVarLengthArray::const_iterator begin, QVarLengthArray::const_iterator end)

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

Удаляет все элементы от begin до (но не включая) end. Возвращает итератор на тот же элемент, на который ссылался end до вызова.

Эта функция была добавлена в Qt 4.8.

T &QVarLengthArray::first()

Возвращает ссылку на первый элемент в массиве. Массив не должен быть пустым. Если массив может быть пустым, проверьте isEmpty() перед вызовом этой функции.

См. также last() и isEmpty().

const T &QVarLengthArray::first() const

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

T &QVarLengthArray::front()

То же самое, что и first(). Предоставлено для совместимости со STL.

Эта функция была добавлена в Qt 5.0.

const T &QVarLengthArray::front() const

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

Эта функция была добавлена в Qt 5.0.

int QVarLengthArray::indexOf(const T &value, int from = ...) const

Возвращает индекс первого вхождения value в массиве, поиск вперед с позиции from. Возвращает -1, если элемент не найден.

Эта функция требует, чтобы тип значения имел реализацию operator==().

Эта функция была добавлена в Qt 5.3.

См. также lastIndexOf() и contains().

void QVarLengthArray::insert(int i, int count, const T &value)

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

Вставляет count копий value в позицию i в векторе.

Эта функция была добавлена в Qt 4.8.

QVarLengthArray::iterator QVarLengthArray::insert(QVarLengthArray::const_iterator before, int count, const T &value)

Вставляет count копий value перед элементом, на который указывает итератор before. Возвращает итератор, указывающий на первый из вставленных элементов.

Эта функция была добавлена в Qt 4.8.

bool QVarLengthArray::isEmpty() const

Возвращает true если размер массива равен 0; в противном случае возвращает false.

См. также size() и resize().

T &QVarLengthArray::last()

Возвращает ссылку на последний элемент в массиве. Массив не должен быть пустым. Если массив может быть пустым, проверьте isEmpty() перед вызовом этой функции.

См. также first() и isEmpty().

const T &QVarLengthArray::last() const

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

int QVarLengthArray::lastIndexOf(const T &value, int from = ...) const

Возвращает индекс последнего вхождения значения value в массиве, поиск назад с позиции from. Если from равно -1 (по умолчанию), поиск начинается с последнего элемента. Возвращает -1, если элемент не найден.

Эта функция требует, чтобы тип значения имел реализацию operator==().

Эта функция была добавлена в Qt 5.3.

См. также indexOf() и contains().

int QVarLengthArray::length() const

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

Эта функция была добавлена в Qt 5.0.

См. также isEmpty() и resize().

void QVarLengthArray::pop_back()

То же самое, что и removeLast(). Предоставлено для совместимости со STL.

Эта функция была добавлена в Qt 5.0.

void QVarLengthArray::push_back(const T &t)

Добавляет элемент t в конец массива, расширяя массив при необходимости. Предоставлено для совместимости со STL.

Эта функция была добавлена в Qt 5.0.

void QVarLengthArray::push_back(T &&t)

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

Примечание: В отличие от перегрузки push_back() для lvalue, передача ссылки на объект, который уже является элементом *this приводит к неопределенному поведению:

vla.push_back(std::move(vla[0])); // BUG: passing an object that is already in the container

Эта функция была добавлена в Qt 5.9.

QVarLengthArray::reverse_iterator QVarLengthArray::rbegin()

Возвращает итератор STL, указывающий на первый элемент в массиве с переменной длиной, в обратном порядке.

Эта функция была добавлена в Qt 5.6.

См. также begin(), crbegin(), и rend().

QVarLengthArray::const_reverse_iterator QVarLengthArray::rbegin() const

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

Эта функция была добавлена в Qt 5.6.

void QVarLengthArray::remove(int i)

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

Удаляет элемент по индексу i.

Эта функция была добавлена в Qt 4.8.

См. также insert() и replace().

void QVarLengthArray::remove(int i, int count)

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

Удаляет count элементов из середины массива, начиная с позиции i.

Эта функция была добавлена в Qt 4.8.

См. также insert() и replace().

void QVarLengthArray::removeLast()

Уменьшает размер массива на единицу. Размер выделенной памяти не изменяется.

Эта функция была добавлена в Qt 4.5.

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

QVarLengthArray::reverse_iterator QVarLengthArray::rend()

Возвращает итератор STL, указывающий на позицию за последним элементом в массиве с переменной длиной, в обратном порядке.

Эта функция была добавлена в Qt 5.6.

См. также end(), crend(), и rbegin().

QVarLengthArray::const_reverse_iterator QVarLengthArray::rend() const

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

Эта функция была добавлена в Qt 5.6.

void QVarLengthArray::replace(int i, const T &value)

Заменяет элемент по индексу i значением value.

i должно быть допустимой позицией индекса в массиве (т.е., 0 <= i < size()).

Эта функция была добавлена в Qt 4.8.

См. также operator[]() и remove().

void QVarLengthArray::reserve(int size)

Попытка выделить память для не менее чем size элементов. Если заранее известно, насколько большим может стать массив, можно вызвать эту функцию, и если часто вызывать resize(), производительность, скорее всего, улучшится. Если size является заниженной оценкой, худшее, что может произойти, — это то, что QVarLengthArray будет немного медленнее.

Единственная цель этой функции — предоставить способ тонкой настройки использования памяти QVarLengthArray. В общем случае вам редко потребуется вызывать эту функцию. Если вы хотите изменить размер массива, вызовите resize().

См. также capacity() и squeeze().

void QVarLengthArray::resize(int size)

Устанавливает размер массива в size. Если size больше текущего размера, элементы добавляются в конец. Если size меньше текущего размера, элементы удаляются с конца.

Если тип значения является примитивным типом (например, char, int, float) или типом указателя (например, QWidget *), новые элементы не инициализируются. Для других типов элементы инициализируются значением по умолчанию.

См. также size() и squeeze().

void QVarLengthArray::shrink_to_fit()

То же самое, что и squeeze(). Предоставлено для совместимости со STL.

Эта функция была добавлена в Qt 5.10.

int QVarLengthArray::size() const

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

См. также isEmpty() и resize().

void QVarLengthArray::squeeze()

Освобождает любую память, не необходимую для хранения элементов. Если контейнер может поместиться в стековой памяти, он освободит выделение кучей и скопирует элементы обратно в стек.

Единственная цель этой функции — предоставить способ тонкой настройки использования памяти QVarLengthArray. В общем случае вам редко потребуется вызывать эту функцию.

Эта функция была добавлена в Qt 5.1.

См. также reserve(), capacity() и resize().

T QVarLengthArray::value(int i) const

Возвращает значение по индексу i.

Если индекс i выходит за пределы массива, функция возвращает значение по умолчанию. Если вы уверены, что i находится в пределах, вы можете использовать at() вместо этого, что немного быстрее.

См. также at() и operator[]().

T QVarLengthArray::value(int i, const T &defaultValue) const

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

Если индекс i выходит за пределы массива, функция возвращает defaultValue.

QVarLengthArray<T, Prealloc> &QVarLengthArray::operator+=(const T &value)

Добавляет value в массив и возвращает ссылку на этот вектор.

Эта функция была добавлена в Qt 4.8.

См. также append() и operator<<().

QVarLengthArray<T, Prealloc> &QVarLengthArray::operator+=(T &&value)

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

Эта функция была добавлена в Qt 5.11.

См. также append() и operator<<().

QVarLengthArray<T, Prealloc> &QVarLengthArray::operator<<(const T &value)

Добавляет value в массив и возвращает ссылку на этот вектор.

Эта функция была добавлена в Qt 4.8.

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

QVarLengthArray<T, Prealloc> &QVarLengthArray::operator<<(T &&value)

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

Эта функция была добавлена в Qt 5.11.

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

QVarLengthArray<T, Prealloc> &QVarLengthArray::operator=(std::initializer_list<T> list)

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

Этот конструктор включён только если компилятор поддерживает C++11 initializer lists.

Эта функция была добавлена в Qt 5.5.

T &QVarLengthArray::operator[](int i)

Возвращает ссылку на элемент по индексу i.

i должно быть допустимой позицией индекса в массиве (т.е., 0 <= i < size()).

См. также data() и at().

const T &QVarLengthArray::operator[](int i) const

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