libstdc++: std::allocator_traits< _Alloc > Struct Template Reference (original) (raw)

#include <[memory](a00140%5Fsource.html)>

Public Types
typedef _Alloc allocator_type
using const_pointer = typename _Ptr< __c_pointer, const value_type >::type
using const_void_pointer = typename _Ptr< __cv_pointer, const void >::type
using difference_type = typename _Diff< _Alloc, pointer >::type
using is_always_equal = typename __detected_or_t< is_empty< _Alloc >, __equal, _Alloc >::type
using pointer = __detected_or_t< value_type *, __pointer, _Alloc >
using propagate_on_container_copy_assignment = __detected_or_t< false_type, __pocca, _Alloc >
using propagate_on_container_move_assignment = __detected_or_t< false_type, __pocma, _Alloc >
using propagate_on_container_swap = __detected_or_t< false_type, __pocs, _Alloc >
template<typename _Tp >
using rebind_alloc = __alloc_rebind< _Alloc, _Tp >
template<typename _Tp >
using rebind_traits = allocator_traits< rebind_alloc< _Tp > >
using size_type = typename _Size< _Alloc, difference_type >::type
typedef _Alloc::value_type value_type
using void_pointer = typename _Ptr< __v_pointer, void >::type
Static Public Member Functions
static constexpr pointer allocate (_Alloc &__a, size_type __n)
static constexpr pointer allocate (_Alloc &__a, size_type __n, const_void_pointer __hint)
template<typename _Tp , typename... _Args> requires __can_construct<_Alloc, _Tp, _Args...>
static constexpr void construct (_Alloc &__a, _Tp *__p, _Args &&... __args) noexcept(_S_nothrow_construct< _Tp, _Args... >())
static constexpr void deallocate (_Alloc &__a, pointer __p, size_type __n)
template<typename _Tp >
static constexpr void destroy (_Alloc &__a, _Tp *__p) noexcept(_S_nothrow_destroy< _Tp >())
static constexpr size_type max_size (const _Alloc &__a) noexcept
static constexpr _Alloc select_on_container_copy_construction (const _Alloc &__rhs)

template<typename _Alloc>
struct std::allocator_traits< _Alloc >

Uniform interface to all allocator types.

Since

C++11

Definition at line 249 of file bits/alloc_traits.h.

allocator_type

template<typename _Alloc >

const_pointer

template<typename _Alloc >

The allocator's const pointer type.

Alloc::const_pointer if that type exists, otherwise pointer_traits<pointer>::rebind<const value_type>

Definition at line 301 of file bits/alloc_traits.h.

const_void_pointer

template<typename _Alloc >

using std::allocator_traits< _Alloc >::const_void_pointer = typename _Ptr<__cv_pointer, const void>::type

The allocator's const void pointer type.

Alloc::const_void_pointer if that type exists, otherwise pointer_traits<pointer>::rebind<const void>

Definition at line 317 of file bits/alloc_traits.h.

difference_type

template<typename _Alloc >

The allocator's difference type.

Alloc::difference_type if that type exists, otherwise pointer_traits<pointer>::difference_type

Definition at line 325 of file bits/alloc_traits.h.

is_always_equal

template<typename _Alloc >

Whether all instances of the allocator type compare equal.

Alloc::is_always_equal if that type exists, otherwise is_empty<Alloc>::type

Definition at line 368 of file bits/alloc_traits.h.

pointer

template<typename _Alloc >

The allocator's pointer type.

Alloc::pointer if that type exists, otherwise value_type*

Definition at line 261 of file bits/alloc_traits.h.

propagate_on_container_copy_assignment

template<typename _Alloc >

How the allocator is propagated on copy assignment.

Alloc::propagate_on_container_copy_assignment if that type exists, otherwise false_type

Definition at line 341 of file bits/alloc_traits.h.

propagate_on_container_move_assignment

template<typename _Alloc >

How the allocator is propagated on move assignment.

Alloc::propagate_on_container_move_assignment if that type exists, otherwise false_type

Definition at line 350 of file bits/alloc_traits.h.

propagate_on_container_swap

template<typename _Alloc >

How the allocator is propagated on swap.

Alloc::propagate_on_container_swap if that type exists, otherwise false_type

Definition at line 359 of file bits/alloc_traits.h.

rebind_alloc

template<typename _Alloc >

template<typename _Tp >

rebind_traits

template<typename _Alloc >

template<typename _Tp >

size_type

template<typename _Alloc >

The allocator's size type.

Alloc::size_type if that type exists, otherwise make_unsigned<difference_type>::type

Definition at line 333 of file bits/alloc_traits.h.

value_type

template<typename _Alloc >

void_pointer

template<typename _Alloc >

The allocator's void pointer type.

Alloc::void_pointer if that type exists, otherwise pointer_traits<pointer>::rebind<void>

Definition at line 309 of file bits/alloc_traits.h.

allocate() [1/2]

template<typename _Alloc >

Allocate memory.

Parameters

__a An allocator.
__n The number of objects to allocate space for.

Calls a.allocate(n)

Definition at line 384 of file bits/alloc_traits.h.

allocate() [2/2]

template<typename _Alloc >

Allocate memory.

Parameters

__a An allocator.
__n The number of objects to allocate space for.
__hint Aid to locality.

Returns

Memory of suitable size and alignment for n objects of type value_type

Returns a.allocate(n, hint) if that expression is well-formed, otherwise returns a.allocate(n)

Definition at line 399 of file bits/alloc_traits.h.

construct()

template<typename _Alloc >

template<typename _Tp , typename... _Args>
requires __can_construct<_Alloc, _Tp, _Args...>

static constexpr void std::allocator_traits< _Alloc >::construct ( _Alloc & __a, _Tp * __p, _Args &&... __args ) inlinestaticconstexprnoexcept

Construct an object of type _Tp

Parameters

__a An allocator.
__p Pointer to memory of suitable size and alignment for Tp
__args Constructor arguments.

Calls __a.construct(__p, std::forward<Args>(__args)...) if that expression is well-formed, otherwise uses placement-new to construct an object of type _Tp at location __p from the arguments __args...

Definition at line 437 of file bits/alloc_traits.h.

References std::_Construct().

deallocate()

template<typename _Alloc >

Deallocate memory.

Parameters

__a An allocator.
__p Pointer to the memory to deallocate.
__n The number of objects space was allocated for.

Calls a.deallocate(p, n)

Definition at line 416 of file bits/alloc_traits.h.

destroy()

template<typename _Alloc >

template<typename _Tp >

static constexpr void std::allocator_traits< _Alloc >::destroy ( _Alloc & __a, _Tp * __p ) inlinestaticconstexprnoexcept

Destroy an object of type _Tp.

Parameters

__a An allocator.
__p Pointer to the object to destroy

Calls __a.destroy(__p) if that expression is well-formed, otherwise calls __p->~_Tp()

Definition at line 456 of file bits/alloc_traits.h.

References std::_Destroy().

max_size()

template<typename _Alloc >

The maximum supported allocation size.

Parameters

Returns

__a.max_size() or numeric_limits<size_type>::max()

Returns __a.max_size() if that expression is well-formed, otherwise returns numeric_limits<size_type>::max()

Definition at line 474 of file bits/alloc_traits.h.

select_on_container_copy_construction()

template<typename _Alloc >

static constexpr _Alloc std::allocator_traits< _Alloc >::select_on_container_copy_construction ( const _Alloc & __rhs) inlinestaticconstexpr

Obtain an allocator to use when copying a container.

Parameters

Returns

__rhs.select_on_container_copy_construction() or __rhs

Returns __rhs.select_on_container_copy_construction() if that expression is well-formed, otherwise returns __rhs

Definition at line 494 of file bits/alloc_traits.h.


The documentation for this struct was generated from the following file: