std::allocate_shared、std::allocate_shared_for_overwrite

ヘッダ `<memory>` で定義
template< class T, class Alloc, class... Args > shared_ptr<T> allocate_shared( const Alloc& alloc, Args&&... args );	(1)	(C++11以降)
template< class T, class Alloc > shared_ptr<T> allocate_shared( const Alloc& alloc, std::size_t N );	(2)	(C++20以降)
template< class T, class Alloc > shared_ptr<T> allocate_shared( const Alloc& alloc );	(3)	(C++20以降)
template< class T, class Alloc > shared_ptr<T> allocate_shared( const Alloc& alloc, std::size_t N, const std::remove_extent_t<T>& u );	(4)	(C++20以降)
template< class T, class Alloc > shared_ptr<T> allocate_shared( const Alloc& alloc, const std::remove_extent_t<T>& u );	(5)	(C++20以降)
template< class T, class Alloc > shared_ptr<T> allocate_shared_for_overwrite( const Alloc& alloc );	(6)	(C++20以降)
template< class T, class Alloc > shared_ptr<T> allocate_shared_for_overwrite( const Alloc& alloc, std::size_t N );	(7)	(C++20以降)

alloc のコピーを使用してオブジェクトのメモリを割り当て、指定された引数でオブジェクトを初期化します。新しく作成されたオブジェクトを管理する std::shared_ptr オブジェクトを返します。

1) オブジェクトは T 型で、std::allocator_traits<Alloc>::construct
(a, pt, (std::forward<Args>(args)...) のように構築されます。ここで、pt は、std::remove_cv_t<T> 型のオブジェクトを格納するのに適したストレージへの const std::remove_cv_t<T>* ポインタです。オブジェクトが破棄される場合、pt はそのオブジェクトへの std::remove_cv_t<T> 型のポインタであり、std::allocator_traits<Alloc>::destroy(a, pt) のように破棄されます。

上記の説明において、a は Alloc 型であり、alloc の再バインドされる可能性のあるコピーです。

このオーバーロードは、T が配列型でない場合にのみオーバーロード解決に参加します。

(C++20以降)

2) オブジェクトは std::remove_extent_t<T>[N] 型です。各要素はデフォルトで初期化されます。

このオーバーロードは、T が未制限の配列型の場合にのみオーバーロード解決に参加します。

3) オブジェクトは T 型です。各要素はデフォルトで初期化されます。

このオーバーロードは、T が制限付き配列型の場合にのみオーバーロード解決に参加します。

4) オブジェクトは std::remove_extent_t<T>[N] 型です。各要素は初期値 u で初期化されます。

このオーバーロードは、T が未制限の配列型の場合にのみオーバーロード解決に参加します。

5) オブジェクトは T 型です。各要素は初期値 u で初期化されます。

このオーバーロードは、T が制限付き配列型の場合にのみオーバーロード解決に参加します。

6) オブジェクトは T 型です。

T が配列型でない場合、オブジェクトは ::new (pv) T のように構築されます。ここで、pv は T 型のオブジェクトを格納するのに適したストレージへの void* ポインタです。オブジェクトが破棄される場合、pt はそのオブジェクトへの T 型のポインタであり、pt->~T() のように破棄されます。
T が制限付き配列型の場合、各要素の初期値は未指定です。

このオーバーロードは、T が配列型でないか、または制限付き配列型の場合にのみオーバーロード解決に参加します。

7) オブジェクトは std::remove_extent_t<T>[N] 型です。各要素の初期値は未指定です。

このオーバーロードは、T が未制限の配列型の場合にのみオーバーロード解決に参加します。

U が配列型でない場合、各要素は、pu が U 型のオブジェクトを格納するのに適したストレージへの std::remove_cv_t<U>* ポインタであり、pv が U 型のオブジェクトを格納するのに適したストレージへの void* ポインタであると仮定して、以下の式のように構築されます。

2,3) std::allocator_traits<Alloc>::construct(a, pu)

4,5) std::allocator_traits<Alloc>::construct(a, pu, u)

6,7) ::new (pv) U

それ以外の場合は、各要素の配列を再帰的に初期化します。次の次元では

U は std::remove_extent_t<U> になります。
オーバーロード (4,5) では、u は u の対応する要素になります。

戻り値の std::shared_ptr によって管理されるオブジェクトの寿命が終了するか、配列要素の初期化中に例外がスローされた場合、初期化された要素は元の構築順と逆順に破棄されます。

非配列型 U の各配列要素を破棄する場合、以下の式のように破棄されます。

2-5) std::allocator_traits<Alloc>::destroy(a, pu)、ここで pu は U 型のその配列要素への U* ポインタです。

6,7) pu->~U()、ここで pu は U 型のその配列要素へのポインタです。

(C++20以降)

[編集] パラメータ

alloc	-	使用するAllocator
args...	-	`T` のインスタンスを構築するために使用される引数のリスト
N	-	使用する配列サイズ
u	-	配列の各要素を初期化するために使用される初期値

[編集] 戻り値

T 型のオブジェクトへの std::shared_ptr。または T が未制限の配列型の場合は std::remove_extent_t<T>[N](C++20以降)。

返された std::shared_ptr r について、r.get() はヌルでないポインタを返し、r.use_count() は 1 を返します。

[編集] 例外

Alloc::allocate() または T のコンストラクタからスローされる例外をスローする可能性があります。例外がスローされた場合、(1) は効果がありません。配列の構築中に例外がスローされた場合、既に初期化された要素は逆順に破棄されます(C++20以降)。

[編集] 注記

これらの関数は通常、内部のブックキーピング構造（参照カウントなど）を格納するために、sizeof(T) よりも多くのメモリを割り当てます。

std::make_shared と同様に、この関数は通常1回の割り当てのみを実行し、T オブジェクトと制御ブロックの両方を割り当てられたメモリブロックに配置します（標準はこれを推奨しますが、義務付けてはいません。既知の実装はすべてこれを行います）。alloc のコピーは制御ブロックの一部として格納されるため、共有および弱参照カウントがゼロに達したときにそれを解放するために使用できます。

std::shared_ptr のコンストラクタとは異なり、std::allocate_shared は個別のカスタムデリータを受け入れません。指定されたアロケータは、制御ブロックと T オブジェクトの破棄、およびそれらの共有メモリブロックの解放に使用されます。

std::shared_ptr は配列型をサポートしますが（C++17以降）、std::allocate_shared はサポートしません。この機能は boost::allocate_shared によってサポートされています。

(C++20まで)

ポインタ ptr の型が U* であるコンストラクタがshared_from_this を有効にするとは、U が一意でアクセス可能な(C++17以降) 基底クラスであり std::enable_shared_from_this の特殊化であるかどうかを判断し、そうである場合、コンストラクタは if (ptr != nullptr && ptr->weak_this .expired())
ptr->weak_this = std::shared_ptr<std::remove_cv_t<U>>
(*this, const_cast<std::remove_cv_t<U>*>(ptr)); を評価します。

weak_this への代入はアトミックではなく、同じオブジェクトへの潜在的な同時アクセスと競合します。これにより、将来の shared_from_this() 呼び出しが、この生ポインタコンストラクタによって作成された std::shared_ptr と所有権を共有することを保証します。

上記のコードのテスト ptr->weak_this .expired() は、weak_this が既に所有者を示している場合に再割り当てされないことを確認します。このテストは C++17 から必須です。

機能テストマクロ	値	規格	機能
`__cpp_lib_smart_ptr_for_overwrite`	`202002L`	(C++20)	デフォルト初期化によるスマートポインタの作成（`std::allocate_shared_for_overwrite`、std::make_shared_for_overwrite、std::make_unique_for_overwrite）；オーバーロード (6,7)

[編集] 例

このコードを実行

#include <cstddef>
#include <iostream>
#include <memory>
#include <memory_resource>
#include <vector>
 
class Value
{
    int i;
public:
    Value(int i) : i(i) { std::cout << "Value(), i = " << i << '\n'; }
    ~Value() { std::cout << "~Value(), i = " << i << '\n'; }
    void print() const { std::cout << "i = " << i << '\n'; }
};
 
int main()
{
    // Create a polymorphic allocator using the monotonic buffer resource
    std::byte buffer[sizeof(Value) * 8];
    std::pmr::monotonic_buffer_resource resource(buffer, sizeof(buffer));
    std::pmr::polymorphic_allocator<Value> allocator(&resource);
 
    std::vector<std::shared_ptr<Value>> v;
 
    for (int i{}; i != 4; ++i)
        // Use std::allocate_shared with the custom allocator
        v.emplace_back(std::allocate_shared<Value>(allocator, i));
 
    for (const auto& sp : v)
        sp->print();
} //< All shared pointers will automatically clean up when they go out of scope.

出力

Value(), i = 0
Value(), i = 1
Value(), i = 2
Value(), i = 3
i = 0
i = 1
i = 2
i = 3
~Value(), i = 0
~Value(), i = 1
~Value(), i = 2
~Value(), i = 3

[編集] 不具合報告

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

DR	適用対象	公開された動作	正しい動作
LWG 3216	C++20	`std::allocate_shared` は常にアロケータをオブジェクトの構築および破棄の前に再バインドします。	再バインドはオプションです
LWG 4024	C++20	`std::allocate_shared_for_overwrite` で構築されるオブジェクトがどのように破棄されるかは不明瞭でした。	明確化された

[編集] 関連項目

(コンストラクタ)	新しい `shared_ptr` を構築する (public メンバ関数) [編集]
make_sharedmake_shared_for_overwrite (C++20)	新しいオブジェクトを管理する共有ポインタを作成します (関数テンプレート) [編集]

コンパイラサポート
フリースタンディングとホスト
言語
標準ライブラリ
標準ライブラリヘッダー
名前付き要件
機能テストマクロ (C++20)
言語サポートライブラリ
コンセプトライブラリ (C++20)
診断ライブラリ
メモリ管理ライブラリ
メタプログラミングライブラリ (C++11)
汎用ユーティリティライブラリ
コンテナライブラリ
イテレータライブラリ
Rangesライブラリ (C++20)
アルゴリズムライブラリ
文字列ライブラリ
テキスト処理ライブラリ
数値ライブラリ
日付と時刻ライブラリ
入出力ライブラリ
ファイルシステムライブラリ (C++17)
並行サポートライブラリ (C++11)
実行制御ライブラリ (C++26)
Technical specifications (技術仕様)
シンボルインデックス
外部ライブラリ

メンバ関数
shared_ptr::shared_ptr
shared_ptr::~shared_ptr
shared_ptr::operator=
変更
shared_ptr::reset
shared_ptr::swap
監視
shared_ptr::get
shared_ptr::operator*shared_ptr::operator->
shared_ptr::operator[] (C++17)
shared_ptr::use_count
shared_ptr::unique (C++20まで*)
shared_ptr::operator bool
shared_ptr::owner_before
shared_ptr::owner_hash (C++26)
shared_ptr::owner_equal (C++26)
非メンバ関数
swap(std::shared_ptr)
make_sharedmake_shared_for_overwrite (C++20)
allocate_sharedallocate_shared_for_overwrite (C++20)
static_pointer_castdynamic_pointer_castconst_pointer_castreinterpret_pointer_cast (C++17)
get_deleter
operator==operator!=operator<operator<=operator>operator>=operator<=> (C++20まで)(C++20まで)(C++20まで)(C++20まで)(C++20まで)(C++20)
operator<<
atomic_xxx 関数 (C++26まで*)
ヘルパークラス
atomic<std::shared_ptr> (C++20)
hash<std::shared_ptr>
推論ガイド(C++17)

cppreference.com

名前空間

変種

表示

操作

std::allocate_shared、std::allocate_shared_for_overwrite

目次

配列要素の初期化と破棄

[編集] パラメータ

[編集] 戻り値

[編集] 例外

[編集] 注記

[編集] 例

[編集] 不具合報告

[編集] 関連項目

ナビゲーション

ツールボックス