ranges_uninitialized_default_construct.md

uninitialized_default_construct

• memory[meta header]
• std::ranges[meta namespace]
• function template[meta id-type]
• cpp20[meta cpp]

namespace std::ranges {
  template <no-throw-forward-iterator I, no-throw-sentinel<I> S>
    requires default_initializable<iter_value_t<I>>
  I
    uninitialized_default_construct(I first, S last); // (1) C++20
  template <no-throw-forward-iterator I, no-throw-sentinel<I> S>
    requires default_initializable<iter_value_t<I>>
  constexpr I
    uninitialized_default_construct(I first, S last); // (1) C++26

  template <no-throw-forward-range R>
    requires default_initializable<range_value_t<R>>
  borrowed_iterator_t<R>
    uninitialized_default_construct(R&& r);           // (2) C++20
  template <no-throw-forward-range R>
    requires default_initializable<range_value_t<R>>
  constexpr borrowed_iterator_t<R>
    uninitialized_default_construct(R&& r);           // (2) C++26
}

• no-throw-forward-iterator[link no-throw-forward-iterator.md]
• no-throw-sentinel[link no-throw-sentinel.md]
• default_initializable[link /reference/concepts/default_initializable.md]
• iter_value_t[link /reference/iterator/iter_value_t.md]
• no-throw-forward-range[link no-throw-forward-range.md]
• range_value_t[link /reference/ranges/range_value_t.md]
• borrowed_iterator_t[link /reference/ranges/borrowed_iterator_t.md]

概要

未初期化領域の範囲 (r、[first, last)) の各要素をデフォルト構築する。

• (1): イテレータ範囲を指定する
• (2): Rangeを直接指定する

テンプレートパラメータ制約

• (1):
  • Iがno-throw-forward-iteratorである
  • SがIに対する例外を投げない番兵である
  • Iの要素型が、デフォルト構築可能である
• (2):
  • Rがno-throw-forward-rangeである
  • Rの要素型が、デフォルト構築可能である

効果

説明用の関数voidifyがあるとして、

template<class T>
constexpr void* voidify(T& obj) noexcept {
  return const_cast<void*>(static_cast<const volatile void*>(addressof(obj)));
}

• addressof[link addressof.md]

以下と等価である：

for (; first != last; ++first)
  ::new (voidify(*first)) remove_reference_t<iter_reference_t<I>>;
return first;

• remove_reference_t[link /reference/type_traits/remove_reference.md]
• iter_reference_t[link /reference/iterator/iter_reference_t.md]

例外

呼び出すコンストラクタなどから例外がスローされた場合、その例外がこの関数の外側に伝播される前に、その時点で構築済のオブジェクトは全て未規定の順序で破棄される。すなわち、例外がスローされた場合は初期化対象領域は未初期化のままとなる。

備考

• std::vectorクラスの要素数を変更する操作は、要素を値構築するためゼロ初期化が行われる。その値初期化のコストが気になるような場合に、デフォルト構築することでプログラマの責任で必要な分だけ任意に初期化でき、パフォーマンス向上が期待できるようになる。
  • 例としてBoost Container Libraryのvectorクラスには、要素数を変更するメンバ関数にデフォルト構築のオプションとしてdefault_initがある

例

#include <iostream>
#include <memory>
#include <algorithm>

struct Vector {
  int x, y;
};

int main()
{
  std::allocator<Vector> alloc;

  // メモリ確保。
  // この段階では、[p, p + size)の領域は未初期化
  const std::size_t size = 3;
  Vector* p = alloc.allocate(size);

  // 未初期化領域[p, p + size)の各要素をデフォルト構築
  std::ranges::uninitialized_default_construct(std::ranges::subrange{p, p + size});

  // pの領域が初期化され、かつ範囲pの全ての要素が2で埋められているか確認
  std::for_each(p, p + size, [](const Vector& v) {
    std::cout << v.x << ',' << v.y << std::endl;
  });

  // 要素を破棄
  std::ranges::destroy(p, p + size);

  // メモリ解放
  alloc.deallocate(p, size);
}

• std::ranges::uninitialized_default_construct[color ff0000]
• std::ranges::subrange[link /reference/ranges/subrange.md]
• std::allocator[link allocator.md]
• alloc.allocate[link allocator/allocate.md]
• std::ranges::destroy[link ranges_destroy.md]
• alloc.deallocate[link allocator/deallocate.md]

出力例

1445540552,1445540279
0,1445540279
0,1445540279

バージョン

言語

• C++20

処理系

• Clang: 16.0 [mark verified]
• GCC: 10.2.0 [mark verified]
• Visual C++: 2019 Update 10 [mark verified]

関連項目

• uninitialized_default_construct

参照

• P0896R4 The One Ranges Proposal
• P3508R0 Wording for "constexpr for specialized memory algorithms"
• P3369R0 constexpr for uninitialized_default_construct
  • 上記2文書で、C++26からconstexprがついた