deallocate.md

deallocate

• memory[meta header]
• std[meta namespace]
• allocator[meta class]
• function[meta id-type]

void deallocate(pointer p, size_type n);                // C++17 まで
constexpr void deallocate(pointer p, size_type n);      // C++20 から

概要

メモリを解放する。

事前条件

• C++20まで
  • pは、allocate()によって確保されたポインタ値であること。nは、アロケートされたpのサイズと同じであること
• C++23以降
  • pがallocate_at_least()によって確保されたポインタ値である場合、allocate_at_least()の戻り値をret、その呼び出しで要求されたサイズをreqとして、
    • pはret.ptrと等しいこと
    • nはreq <= n <= ret.countとなる値であること
  • そうでなければ、pは、allocate()によって確保されたポインタ値であること。nは、アロケートされたpのサイズと同じであること

効果

pが指すストレージを解放する。

• C++11まで : 解放には::operator delete(void*)を使用するが、この関数がいつ呼び出されるかは未規定。
• C++14から : 解放には::operator delete(void*, std::size_t)を使用するが、この関数がいつ呼び出されるかは未規定。

例

#include <memory>

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

  // 10要素のint領域を確保する
  std::size_t n = 10;
  int* p = alloc.allocate(n);

  // 確保したメモリを解放する
  alloc.deallocate(p, n);
}

• deallocate[color ff0000]
• alloc.allocate[link allocate.md]

出力

参照

• C++14 サイズ付きデアロケーション
• P0784R7 More constexpr containers
• P0401R6 Providing size feedback in the Allocator interface
  • C++23でallocate_at_least()関数が導入されたことにより、この関数の事前条件として、渡される値にその関数の戻り値であることも考慮された