std::pmr::p...locate_bytes(3)

📦 version 2024.07.05, in nixpkgs unstable, opensuse-leap 16.0

💖 std::pmr::p...locate_bytes(3) — C++ Standard Libary 💖

okay bestie, welcome to the C++ Standard Libary corner of the manualverse 💅 We're reading std::pmr::p...locate_bytes(3), and the p...locate is just the truncation being dramatic. The actual function is std::pmr::polymorphic_allocator::deallocate_bytes, and yes she has main character energy.

🌸 NAME 🌸

std::pmr::polymorphic_allocator::deallocate_bytes — std::pmr::polymorphic_allocator::deallocate_bytes.

Literally the same name twice, and honestly? iconic 🫶

✨ Synopsis ✨

The signature, served fresh:

void deallocate_bytes( void* p,
                       std::size_t nbytes,
                       std::size_t alignment = alignof(std::max_align_t) );

Tagged (since C++20), so set your mental compiler to C++20 mode ⭐

Okay so deallocate_bytes deallocates the storage pointed to by p, and that p must have been allocated from a std::pmr::memory_resource x that compares equal to *resource(), using x.allocate(nbytes, alignment) — typically through a call to allocate_bytes(nbytes, alignment).

It's equivalent to:

resource()->deallocate(p, nbytes, alignment);

🎀 Parameters 🎀

  • p — pointer to memory to deallocate. bye-bye, memory 👋
  • nbytes — the number of bytes originally allocated.
  • alignment — the alignment originally allocated.

💀 Exceptions 💀

Throws nothing. That's it. no drama, no surprise throws, just peace and quiet 💅

🦋 Notes 🦋

This function was introduced for use with the fully-specialized allocator std::pmr::polymorphic_allocator<>, but it may be useful in any specialization. cute versatility, no cap ✨

🌈 See Also 🌈

  • deallocate_object (C++20) — frees raw memory obtained by allocate_object (public member function).
  • delete_object (C++20) — destroys and deallocates an object (public member function).
  • deallocate [static] — deallocates storage using the allocator (public static member function of std::allocator_traits<Alloc>).
  • deallocate — deallocates memory (public member function of std::pmr::memory_resource).

kisses bestie, this page came from http://cppreference.com, dated 2024.06.10, and it's the std::pmr::p...locate_bytes(3) manual page. mwah 💋🎀

📦 where this page comes from