std::allocator<T>::allocate_at_least

 

C++

コンパイラサポート

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

言語

標準ライブラリ

標準ライブラリヘッダー

名前付き要件

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

言語サポートライブラリ

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

診断ライブラリ

メモリ管理ライブラリ

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

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

コンテナライブラリ

イテレータライブラリ

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

アルゴリズムライブラリ

文字列ライブラリ

テキスト処理ライブラリ

数値ライブラリ

日付と時刻ライブラリ

入出力ライブラリ

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

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

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

Technical specifications (技術仕様)

シンボルインデックス

外部ライブラリ

 

メモリ管理ライブラリ

voidify (説明用*) 未初期化メモリのアルゴリズム uninitialized_copy uninitialized_fill uninitialized_move (C++17) uninitialized_default_construct (C++17) uninitialized_value_construct (C++17) destroy (C++17) destroy_at (C++17) uninitialized_copy_n (C++11) uninitialized_fill_n uninitialized_move_n (C++17) uninitialized_default_construct_n (C++17) uninitialized_value_construct_n (C++17) destroy_n (C++17) construct_at (C++20) 制約付き未初期化 メモリアルゴリズム ranges::uninitialized_copy (C++20) ranges::uninitialized_fill (C++20) ranges::uninitialized_move (C++20) ranges::construct_at (C++20) ranges::destroy (C++20) ranges::destroy_n (C++20) ranges::destroy_at (C++20) ranges::uninitialized_copy_n (C++20) ranges::uninitialized_fill_n (C++20) ranges::uninitialized_move_n (C++20) ranges::uninitialized_default_construct (C++20) ranges::uninitialized_value_construct (C++20) ranges::uninitialized_default_construct_n (C++20)  ranges::uninitialized_value_construct_n (C++20) Cライブラリ malloc calloc realloc aligned_alloc (C++17) free

アロケータ allocator allocator_traits (C++11) allocation_result (C++23) allocator_arg (C++11) uses_allocator (C++11) uses_allocator_construction_args (C++20) make_obj_using_allocator (C++20) uninitialized_construct_using_allocator (C++20)  scoped_allocator_adaptor (C++11) pmr::polymorphic_allocator (C++17) メモリリソース pmr::memory_resource (C++17) pmr::get_default_resource (C++17) pmr::set_default_resource (C++17) pmr::new_delete_resource (C++17) pmr::null_memory_resource (C++17) pmr::synchronized_pool_resource (C++17) pmr::unsynchronized_pool_resource (C++17) pmr::monotonic_buffer_resource (C++17) pmr::pool_options (C++17) ガベージコレクションのサポート declare_reachable (C++11)(C++23まで) undeclare_reachable (C++11)(C++23まで) declare_no_pointers (C++11)(C++23まで) undeclare_no_pointers (C++11)(C++23まで) pointer_safety (C++11)(C++23まで) get_pointer_safety (C++11)(C++23まで) 未初期化ストレージ raw_storage_iterator (C++20まで*) get_temporary_buffer (C++20まで*) return_temporary_buffer (C++20まで*) 明示的な生存期間管理 start_lifetime_asstart_lifetime_as_array (C++23)(C++23)

スマートポインタ unique_ptr (C++11) shared_ptr (C++11) weak_ptr (C++11) auto_ptr (C++17まで*) owner_less (C++11) owner_less<void> (C++17) owner_hash (C++26) owner_equal (C++26) enable_shared_from_this (C++11) bad_weak_ptr (C++11) default_delete (C++11) out_ptr_t (C++23) inout_ptr_t (C++23) 低レベルメモリ 管理 operator new operator new[] operator delete operator delete[] get_new_handler (C++11) set_new_handler launder (C++17) bad_alloc bad_array_new_length (C++11) nothrow_t align_val_t (C++17) destroying_delete_t (C++20) new_handler nothrow その他 pointer_traits (C++11) to_address (C++20) addressof (C++11) align (C++11) assume_aligned (C++20) is_sufficiently_aligned (C++26)

 

std::allocator

メンバ関数

allocator::allocator

allocator::~allocator

allocator::address (C++20まで)

allocator::allocate

allocator::allocate_at_least (C++23)

allocator::deallocate

allocator::max_size (C++20まで)

allocator::construct (C++20まで)

allocator::destroy (C++20まで)

非メンバ関数

operator==operator!= (C++20まで)

 

constexpr std::allocation_result<T*, std::size_t>     allocate_at_least( std::size_t n );		(C++23から)

「count は、n 以上の未指定の整数値」であるような、count * sizeof(T) バイトの未初期化ストレージを、(おそらく `std::align_val_t` 引数付きの) `::operator new` を呼び出すことで確保する。しかし、この関数がいつ、どのように呼び出されるかは未指定である。

その後、この関数はストレージ内に `T[count]` 型の配列を作成し、その生存期間を開始するが、その要素のいずれかの生存期間は開始しない。

この関数を定数式で使用するには、確保されたストレージは同じ式の評価中に解放されなければならない。

T が不完全型である場合、この関数の使用は不正な形式である。

パラメータ

n

-

ストレージを確保するオブジェクトの数の下限

戻り値

std::allocation_result<T*>{p, count}。ここで、p は count 個の T 型のオブジェクトの配列の最初の要素を指し、その要素はまだ構築されていない。

例外

std::numeric_limits<std::size_t>::max() / sizeof(T) < n の場合、std::bad_array_new_length をスローし、確保に失敗した場合は std::bad_alloc をスローする。

注釈

allocate_at_least は主に、可能であれば容量を実際に確保されたサイズに一致させることにより、再割り当てを減らすために、std::vector や std::basic_string のような連続コンテナのために提供されている。

「いつ、どのように呼び出されるかは未指定」という表現により、標準ライブラリコンテナによるヒープ割り当てを 結合したり最適化したりすることが可能になる。たとえそのような最適化が `::operator new` への直接呼び出しでは許可されていなくても。例えば、これは libc++ によって実装されている ([1] および [2])。

allocate_at_least を呼び出した後、要素の構築前に、`T*` のポインタ演算は確保された配列内で適切に定義されるが、要素にアクセスした場合は未定義の動作となる。

機能テストマクロ	値	規格	機能
__cpp_lib_allocate_at_least	202302L	(C++23)	allocate_at_least など。

例

このコードを実行

#include <memory>
#include <print>
 
int main()
{
    const std::size_t count{69};
    std::allocator<int> alloc;
    std::allocation_result res{alloc.allocate_at_least(count)};
    std::print("count: {}\n"
               "res.ptr: {}\n"
               "res.count: {}\n", count, res.ptr, res.count);
 
    /* construct, use, then destroy elements */
 
    alloc.deallocate(res.ptr, res.count);
}

実行結果の例

count: 69
res.ptr: 0x555a486a0960
res.count: 96

関連項目

allocation_result (C++23)	allocate_at_least によって割り当てられたストレージのアドレスと実際のサイズを記録します (クラステンプレート)
allocate_at_least [static] (C++23)	アロケーターを介して、要求されたサイズ以上のストレージを割り当てます。 (std::allocator_traits<Alloc> の public static メンバー関数)