STD::SCOPED_ALLOCATOR_ADAPTOR(3)

💖 std::scoped_allocator_adaptor< _OuterAlloc, _InnerAllocs > 💖

okay so bestie, we're in the Library Functions Manual today (the page is std::scope...erAllocs >(3), and yes the title is literally truncated with a ..., she's giving mysterious 🔥), and we're talking about the allocator adaptor that recursively hands an allocator down to the objects it constructs. That's the whole vibe. No cap. 💅

NAME

std::scoped_allocator_adaptor< _OuterAlloc, _InnerAllocs > — an adaptor to recursively pass an allocator to the objects it constructs. ✨

---

SYNOPSIS

#include <scoped_allocator>

Public Types

typedef __traits::const_pointer const_pointer
typedef __traits::const_void_pointer const_void_pointer
typedef __traits::difference_type difference_type
typedef __inner_type::__type inner_allocator_type
typedef __and_< typename__traits::is_always_equal,
    typenameallocator_traits< _InnerAllocs >::is_always_equal... >::type
    is_always_equal
typedef _OuterAlloc outer_allocator_type
typedef __traits::pointer pointer
typedef __or_< typename__traits::propagate_on_container_copy_assignment,
    typenameallocator_traits< _InnerAllocs
    >::propagate_on_container_copy_assignment... >::type
    propagate_on_container_copy_assignment
typedef __or_< typename__traits::propagate_on_container_move_assignment,
    typenameallocator_traits< _InnerAllocs
    >::propagate_on_container_move_assignment... >::type
    propagate_on_container_move_assignment
typedef __or_< typename__traits::propagate_on_container_swap,
    typenameallocator_traits< _InnerAllocs
    >::propagate_on_container_swap... >::type
    propagate_on_container_swap
typedef __traits::size_type size_type
typedef __traits::value_type value_type
typedef __traits::void_pointer void_pointer

like look at that typedef list, she is booked and busy 😭 every single one of them is here, none skipped, that's the rule bestie.

Public Member Functions

template<typename _Outer2, typename = _Constructible<_Outer2>>
    scoped_allocator_adaptor (_Outer2 &&__outer, const _InnerAllocs &...
    __inner) noexcept
scoped_allocator_adaptor (const scoped_allocator_adaptor &__other)
    noexcept
template<typename _Outer2, typename = _Constructible<const _Outer2&>>
    scoped_allocator_adaptor (const scoped_allocator_adaptor< _Outer2,
    _InnerAllocs... > &__other) noexcept
scoped_allocator_adaptor (scoped_allocator_adaptor &&__other) noexcept
template<typename _Outer2, typename = _Constructible<_Outer2>>
    scoped_allocator_adaptor (scoped_allocator_adaptor< _Outer2,
    _InnerAllocs... > &&__other) noexcept
pointer allocate (size_type __n)
pointer allocate (size_type __n, const_void_pointer __hint)
template<typename _Tp, typename... _Args> void construct (_Tp *__p,
    _Args &&... __args)
void deallocate (pointer __p, size_type __n) noexcept
template<typename _Tp> void destroy (_Tp *__p)
const inner_allocator_type & inner_allocator () const noexcept
inner_allocator_type & inner_allocator () noexcept
size_type max_size () const
scoped_allocator_adaptor & operator= (const scoped_allocator_adaptor
    &)=default
scoped_allocator_adaptor & operator= (scoped_allocator_adaptor
    &&)=default
const outer_allocator_type & outer_allocator () const noexcept
outer_allocator_type & outer_allocator () noexcept
scoped_allocator_adaptor select_on_container_copy_construction () const

not me counting the constructors… five of them. she contains multitudes fr fr 🦋 and note the noexcept girlies living their truth, plus two operator= that are just =default, living their best lowkey life.

Friends

template<typename...> struct __inner_type_impl
template<typename _OutA1, typename _OutA2, typename... _InA> bool
    operator== (const scoped_allocator_adaptor< _OutA1, _InA... > &__a,
    const scoped_allocator_adaptor< _OutA2, _InA... > &__b) noexcept

friends 💞 the inner circle, literally. and yes the second one is operator==, she's also in the related symbols list below, because she gets around (affectionate).

Related Symbols

Note that these are not member symbols.

template<typename _OutA1, typename _OutA2, typename... _InA> bool
    operator== (const scoped_allocator_adaptor< _OutA1, _InA... > &__a,
    const scoped_allocator_adaptor< _OutA2, _InA... > &__b) noexcept

same operator== as above, just hanging out in the related-symbols section instead of the friends section. iconic, honestly. 🫶

---

Detailed Description

template<typename _OuterAlloc, typename... _InnerAllocs>
    class std::scoped_allocator_adaptor< _OuterAlloc, _InnerAllocs >"An
    adaptor to recursively pass an allocator to the objects it constructs.

so the template signature is template<typename _OuterAlloc, typename... _InnerAllocs>, the class is std::scoped_allocator_adaptor< _OuterAlloc, _InnerAllocs >, and the description is — say it with me — an adaptor to recursively pass an allocator to the objects it constructs. (yes there's a stray " in there before An. she left it in. we respect her choices. 💀)

Author

Generated automatically by Doxygen for libstdc++ from the source code.

---

and that's the whole page bestie, every type, every constructor, every noexcept, the friends, the related symbols, the detailed description, all of it 🎀 no detail left behind, that's main character energy.

cute little sign-off: this page's footer names libstdc++ as the source, and it's page std::scope...erAllocs >(3) from the Library Functions Manual, generated by Doxygen straight from the source code — no date on this one, she simply didn't feel like it. periodt. 💅✨