std::basic_string<CharT,Traits,Allocator>::reserve

 

C++

Поддержка компилятором

Автономные и размещённые реализации

Язык

Стандартная библиотека

Заголовки стандартной библиотеки

Требования к именованию

Макросы тестирования функциональности (C++20)

Поддержка языка

Библиотека концептов (C++20)

Библиотека метапрограммирования (C++11)

Библиотека диагностики

Библиотека общих утилит

Библиотека строк

Библиотека контейнеров

Библиотека итераторов

Библиотека диапазонов (C++20)

Библиотека алгоритмов

Библиотека численных данных

Библиотека ввода/вывода

Библиотека локализаций

Регулярные выражения (C++11)

Атомарные операции (C++11)

Библиотека поддержки конкуренции (C++11)

Библиотека файловой системы (C++17)

Технические спецификации

Указатель символов

Внешние библиотеки

 

Строки

Строки с завершающим нулём

Однобайтовые строки

Многобайтовые строки

Широкие строки

Классы

basic_string

basic_string_view (C++17)

char_traits

 

std::basic_string

Функции-элементы basic_string::basic_string basic_string::~basic_string basic_string::operator= basic_string::assign basic_string::assign_range (C++23) basic_string::get_allocator Доступ к элементам basic_string::at basic_string::operator[] basic_string::front (DR*) basic_string::back (DR*) basic_string::data basic_string::c_str basic_string::operator  basic_string_view (C++17) Итераторы basic_string::beginbasic_string::cbegin (DR*) basic_string::endbasic_string::cend (DR*) basic_string::rbeginbasic_string::crbegin (DR*) basic_string::rendbasic_string::crend (DR*) Ёмкость basic_string::empty basic_string::sizebasic_string::length basic_string::max_size basic_string::reserve basic_string::capacity basic_string::shrink_to_fit (DR*) Операции basic_string::clear basic_string::insert basic_string::insert_range (C++23) basic_string::erase basic_string::push_back basic_string::pop_back (DR*) basic_string::append basic_string::append_range (C++23) basic_string::operator+= basic_string::compare basic_string::replace basic_string::replace_with_range (C++23) basic_string::substr basic_string::copy basic_string::resize basic_string::resize_and_overwrite (C++23)   basic_string::swap

Поиск basic_string::starts_with (C++20)   basic_string::ends_with (C++20) basic_string::contains (C++23) basic_string::find basic_string::rfind basic_string::find_first_of basic_string::find_first_not_of basic_string::find_last_of basic_string::find_last_not_of Константы basic_string::npos Правила вывода (C++17) Функции, не являющиеся элементами operator+ swap(std::basic_string) operator""s (C++14) erase(std::basic_string)erase_if(std::basic_string) (C++20)(C++20) Ввод/Вывод operator<<operator>> getline Сравнение operator==operator!=operator<operator>operator<=operator>=operator<=> (до C++20)(до C++20)(до C++20)(до C++20)(до C++20)(C++20) Числовые преобразования stoistolstoll (C++11)(C++11)(C++11) stoulstoull (C++11)(C++11) stofstodstold (C++11)(C++11)(C++11) to_string (C++11) to_wstring (C++11) Вспомогательные классы hash<std::string>hash<std::wstring>hash<std::u32string>hash<std::u16string>hash<std::u8string> (C++11)  (C++11)(C++11)(C++11)(C++20) hash<std::pmr::string>hash<std::pmr::wstring>hash<std::pmr::u32string>hash<std::pmr::u16string>hash<std::pmr::u8string> (C++17)(C++17)(C++17)(C++17)(C++20)

 

	(1)
void reserve( size_type new_cap = 0 );			(до C++20)
constexpr void reserve( size_type new_cap );			(начиная с C++20)
void reserve();		(2)	(начиная с C++20) (устарело)

1) Информирует объект std::basic_string о запланированном изменении размера, чтобы он мог соответствующим образом управлять распределением памяти.

• Если new_cap больше текущего значения capacity(), выделяется новое хранилище, а capacity() становится равным или большим, чем new_cap.

Если new_cap меньше текущего значения capacity(), это необязательный запрос на сжатие. Если new_cap меньше текущего size(), это необязательный запрос на сжатие эквивалентный shrink_to_fit() (начиная с C++11).	(до C++20)
Если new_cap меньше или равно текущему capacity(), эффекта нет.	(начиная с C++20)

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

2) Необязательный запрос на усадку по размеру. После этого вызова capacity() имеет неопределённое значение, большее или равное size().

Параметры

new_cap

—

новая ёмкость строки

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

(нет)

Исключения

Генерирует std::length_error, если new_cap больше, чем max_size().

Может генерировать любые исключения, создаваемые std::allocator_traits<Allocator>::allocate(), например std::bad_alloc.

Если по какой-либо причине генерируется исключение, эта функция не имеет эффекта (строгая гарантия безопасности исключений).

Сложность

Максимально линейная по size() строки.

Пример

Запустить этот код

#include <cassert>
#include <iostream>
#include <string>
 
int main()
{
    std::string s;
    const std::string::size_type new_capacity{100u};
    std::cout << "Перед: " << s.capacity() << '\n';
 
    s.reserve(new_capacity);
    std::cout << "После:  " << s.capacity() << '\n';
    assert(new_capacity <= s.capacity());
 
    // наблюдение коэффициента роста ёмкости
    auto cap{s.capacity()};
    for (int check{}; check != 4; ++check)
    {
        while (cap == s.capacity())
            s += '$';
        cap = s.capacity();
        std::cout << "Новая ёмкость: " << cap << '\n';
    }
 
    // s.reserve(); // не рекомендуется в C++20, используйте:
    s.shrink_to_fit();
    std::cout << "После:  " << s.capacity() << '\n';
}

Возможный вывод:

Перед: 15
После:  100
Новая ёмкость: 200
Новая ёмкость: 400
Новая ёмкость: 800
Новая ёмкость: 1600
После:  801

Отчёты о дефектах

Следующие изменения поведения были применены с обратной силой к ранее опубликованным стандартам C++:

Номер	Применён	Поведение в стандарте	Корректное поведение
LWG 847	C++98	не было гарантии безопасности исключений	добавлена надёжная гарантия безопасности исключений

Смотрите также

capacity	возвращает количество символов, которые могут храниться в выделенной в данный момент памяти (public функция-элемент)
resize	изменяет количество сохранённых символов (public функция-элемент)