最終更新日時(UTC):
が更新

履歴 編集

function template
<memory>

std::allocate_shared(C++11)

namespace std {
  template<class T, class Alloc, class... Args>
  shared_ptr<T> allocate_shared(const Alloc& a, Args&&... args); // (1)

  template<class T, class A>
  shared_ptr<T> allocate_shared(const A& a, size_t N);           // (2) C++20 から

  template<class T, class A>
  shared_ptr<T> allocate_shared(const A& a);                     // (3) C++20 から

  template<class T, class A>
  shared_ptr<T> allocate_shared(const A& a, size_t N,
                                const remove_extent_t<T>& u);    // (4) C++20 から

  template<class T, class A>
  shared_ptr<T> allocate_shared(const A& a,
                                const remove_extent_t<T>& u);    // (5) C++20 から  
}

概要

class T に対する shared_ptr<T>オブジェクト を作成し返却する。

このとき、args... で受け取った引数リストを型 T の作成時コンストラクタへ渡して作成する。

また、shared_ptr 構築に必要なメモリのアロケートおよびデアロケートを第一引数のアロケータで行う。

一般的にアロケータは型 T のサイズより大きいサイズのアロケートを要求される。

これは、make_shared と同様に型 Tshared_ptr の管理領域を1つの大きなブロックとしてアロケートすることが実装に推奨されているためである。

また、コピー不可能なクラスもムーブによって引数リストへ渡すことが可能である。

要件

テンプレートパラメータACpp17Allocatorの要件を満たす。

効果

Tのオブジェクトにメモリを割り当てる(TU[]の場合はU[N]Nはそれぞれのオーバーロードで指定された引数から決定される)。メモリは、引数aのコピー(value_type のためのリバウンド。value_type は、参照カウンタと型Tの本体を連続メモリ領域に配置するためのTのサイズより大きい領域をアロケートできるような型だと考えられる)を使用して割り当てられる。

オブジェクトは、それぞれのオーバーロードで指定された引数から初期化される。

例外がスローされた場合、関数は効果がない。

配列型Uのオブジェクトが(同じ型の)uの初期値を持つように指定されている場合、これは、オブジェクトの各配列要素が初期値としてuからの対応する要素を持つことを意味すると解釈される。

配列タイプのオブジェクトがデフォルトの初期値を持つように指定されている場合、これはオブジェクトの各配列要素がデフォルトの初期値を持つことを意味すると解釈される。

非配列型Uの(サブ)オブジェクトが初期値vまたはU(l...)を持つように指定されている場合(l...はコンストラクター引数のリスト)、この関数は次の式を介してこの(サブ)オブジェクトを初期化する。

  • allocator_traits<A2>::construct(a2, pv, v) または

  • allocator_traits<A2>::construct(a2, pv, l...)

それぞれ、pvは型Uのオブジェクトを保持するのに適したストレージを指し、型A2a2は、value_typeremove_cv_t<U>になるようにallocate_sharedに渡されるアロケーターaのリバウンドコピーである。ここで、リバウンドコピーとは、参照カウンタと型Tの本体を連続メモリ領域に配置するためにはTのサイズより大きい領域をアロケートする必要があるためにallocator_traits<Alloc>::rebind_alloc<value_type>を用いて再束縛されたものである。

非配列型Uの(サブ)オブジェクトがデフォルトの初期値を持つように指定されている場合、この関数は、式 allocator_traits<A2>::construct(a2、pv)を介してこの(サブ)オブジェクトを初期化する。ここで、pvは、型Uのオブジェクトを保持するのに適したストレージを指し、タイプA2a2は、value_typeremove_cv_t<U>になるように、allocate_sharedに渡されるアロケーターaのリバウンドコピーである。

配列要素は、アドレスの昇順で初期化される。

戻り値によって管理されるオブジェクトのlifetimeが終了するか、配列要素の初期化が例外をスローすると、初期化された要素は元の構造の逆の順序で破棄される。

この関数によって初期化された非配列型Uの(サブ)オブジェクトが破棄される場合、式allocator_traits<A2>::destroy(a2、pv)によって破棄される。pvはその型のオブジェクトを指す。remove_cv_t<U>および型A2a2は、value_typeremove_cv_t<U>になるようにallocate_sharedに渡されるアロケーターaの再束縛されたコピーである。

  • (1) : 初期値T(forward<Args>(args)...)を持つ型Tのオブジェクトへのshared_ptrを返す。Tが配列型でない場合にのみ、このオーバーロードはオーバーロード解決に関与する。この関数によって呼び出されるshared_ptrコンストラクターは、型Tの新しく構築されたオブジェクトのアドレスでshared_from_thisを有効にする。
  • (2) : デフォルトの初期値を持つU[N]型のオブジェクトへのshared_ptrを返す。ここで、Uremove_extent_t<T>である。Tの形式がU[]の場合にのみ、このオーバーロードはオーバーロード解決に関与する。
  • (3) : デフォルトの初期値を持つT型のオブジェクトへのshared_ptrを返す。このオーバーロードは、TU[N]の形式の場合にのみオーバーロード解決に関与する。
  • (4) : U[N]型のオブジェクトへのshared_ptrを返す。ここで、Uremove_extent_t<T>であり、各配列要素の初期値はuである。Tの形式がU[]の場合にのみ、このオーバーロードはオーバーロード解決に関与する。
  • (5) : 型Tのオブジェクトへのshared_ptrを返す。ここで、型remove_extent_t<T>の各配列要素は初期値uを持つ。

戻り値

新しく構築されたオブジェクトのアドレスを格納および所有するshared_ptrインスタンス。

事後条件

r.get() != 0 && r.use_count() == 1, ここで、r は戻り値である。

例外

bad_alloc、またはallocateまたはオブジェクトの初期化からスローされた例外。

備考

同様の効果を持つ関数に、make_shared()があるが、 この関数はメモリの確保にユーザー定義のアロケータを使用したい場合などに用いることができる。

#include <memory>
#include <iostream>

int main() {
  std::allocator<int> alloc;
  std::shared_ptr<int> sp = std::allocate_shared<int>(alloc, 42);
  if (sp) {
    std::cout << *sp << std::endl;
  }
}

出力

42

バージョン

言語

  • C++11

処理系

  • Clang: 3.2, 3.3
  • GCC: 4.7.3, 4.8.2
  • ICC: ??
  • Visual C++: 2010, 2012, 2013
    • 2012までは、可変引数テンプレートに対応していないため、不完全な実装である。

関連項目

参照