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

 

C++

コンパイラサポート

フリースタンディングとホスト

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

機能テストマクロ (C++20)

言語サポートライブラリ

コンセプトライブラリ (C++20)

診断ライブラリ

メモリ管理ライブラリ

メタプログラミングライブラリ (C++11)

汎用ユーティリティライブラリ

コンテナライブラリ

イテレータライブラリ

Rangesライブラリ (C++20)

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

ファイルシステムライブラリ (C++17)

並行サポートライブラリ (C++11)

実行制御ライブラリ (C++26)

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

文字列ライブラリ

クラス

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 (C++11) basic_string::endbasic_string::cend (C++11) basic_string::rbeginbasic_string::crbegin (C++11) basic_string::rendbasic_string::crend (C++11) 検索 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::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::replace basic_string::replace_with_range (C++23) basic_string::copy basic_string::resize basic_string::resize_and_overwrite (C++23)  basic_string::swap 容量 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::compare basic_string::starts_with (C++20) basic_string::ends_with (C++20) basic_string::contains (C++23) basic_string::substr

定数 basic_string::npos 非メンバ関数 operator+ swap(std::basic_string) erase(std::basic_string)erase_if(std::basic_string) (C++20)(C++20) I/O 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) リテラル operator""s (C++14) ヘルパークラス hash<std::basic_string> (C++11) 推論ガイド (C++17)

 

	(1)
void reserve( size_type new_cap = 0 );			(C++20まで)
constexpr void reserve( size_type new_cap );			(C++20以降)
void reserve();		(2)	(C++20以降) (C++20で非推奨) (C++26で削除)

1) std::basic_string オブジェクトに、計画されたサイズの変更を通知し、ストレージ割り当てを適切に管理できるようにします。

• new_cap が現在の capacity() より大きい場合、新しいストレージが割り当てられ、capacity() は new_cap 以上になります。

new_cap が現在の capacity() より小さい場合、これは非拘束的な縮小要求です。 new_cap が現在の size() より小さい場合、これは非拘束的な shrink-to-fit 要求です。これは shrink_to_fit() と同等です(C++11 以降)。	(C++20まで)
new_cap が現在の capacity() 以下の場合、効果はありません。	(C++20以降)

容量の変更が発生した場合、past-the-end イテレータを含むすべてのイテレータと参照は無効になります。

2) 非拘束的な shrink-to-fit 要求。この呼び出し後、capacity() は size() 以上で未指定の値になります。

パラメータ

new_cap

-

文字列の新しい容量

戻り値

(なし)

例外

new_cap が max_size() より大きい場合、std::length_error をスローします。

std::allocator_traits<Allocator>::allocate() によってスローされる可能性のあるすべての例外（例: std::bad_alloc）をスローする可能性があります。

何らかの理由で例外がスローされた場合、この関数は効果がありません（強力な例外安全保証）。

計算量

文字列の size() に対して最大線形。

例

このコードを実行

#include <cassert>
#include <iostream>
#include <string>
 
int main()
{
    std::string s;
    std::cout << "1) Initially: " << s.capacity() << '\n';
 
    const std::string::size_type new_cap{101u};
    s.reserve(new_cap);
    assert(s.capacity() >= new_cap);
    std::cout << "2) After reserve(" << new_cap << "): " << s.capacity() << '\n';
 
    // observing the capacity growth factor
    auto cap{s.capacity()};
    for (int check{}; check != 4; ++check)
    {
        while (cap == s.capacity())
            s += '$';
        cap = s.capacity();
        std::cout << (3) + check << ") Capacity: " << cap << '\n';
    }
 
//  s.reserve(); // deprecated/removed in C++20/26, use:
    s.shrink_to_fit();
    std::cout << "7) After shrink_to_fit: " << s.capacity() << '\n';
}

実行結果の例

1) Initially: 15
2) After reserve(101): 101
3) Capacity: 202
4) Capacity: 404
5) Capacity: 808
6) Capacity: 1616
7) After shrink_to_fit: 809

欠陥報告

以下の動作変更を伴う欠陥報告が、以前に公開されたC++標準に遡って適用されました。

DR	適用対象	公開された動作	正しい動作
LWG 847	C++98	例外安全性保証がなかった	強力な例外安全性保証を追加

関連項目

capacity	現在割り当てられているストレージに保持できる文字数を返す (public member function)
resize	格納されている文字数を変更する (public member function)