libstdc++
std::allocator_traits< typename > Struct Template Reference

#include <memory>

Public Types

typedef _Alloc allocator_type
 
using const_pointer
 
using const_void_pointer
 
using difference_type
 
using is_always_equal
 
using pointer
 
using propagate_on_container_copy_assignment
 
using propagate_on_container_move_assignment
 
using propagate_on_container_swap
 
template<typename _Tp >
using rebind_alloc
 
template<typename _Tp >
using rebind_traits
 
using size_type
 
typedef _Alloc::value_type value_type
 
using void_pointer
 

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>
static constexpr auto construct (_Alloc &__a, _Tp *__p, _Args &&... __args) noexcept(noexcept(_S_construct(__a, __p, std::forward< _Args >(__args)...))) -> decltype(_S_construct(__a, __p, std::forward< _Args >(__args)...))
 
static constexpr void deallocate (_Alloc &__a, pointer __p, size_type __n)
 
template<typename _Tp >
static constexpr void destroy (_Alloc &__a, _Tp *__p) noexcept(noexcept(_S_destroy(__a, __p, 0)))
 
static constexpr size_type max_size (const _Alloc &__a) noexcept
 
static constexpr _Alloc select_on_container_copy_construction (const _Alloc &__rhs)
 

Detailed Description

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

Uniform interface to all allocator types.

Since
C++11

Definition at line 76 of file memoryfwd.h.

Member Typedef Documentation

◆ allocator_type

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

The allocator type.

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

◆ const_pointer

template<typename >
using std::allocator_traits< typename >::const_pointer

The allocator's const pointer type.

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

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

◆ const_void_pointer

template<typename >
using std::allocator_traits< typename >::const_void_pointer

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 174 of file bits/alloc_traits.h.

◆ difference_type

template<typename >
using std::allocator_traits< typename >::difference_type

The allocator's difference type.

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

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

◆ is_always_equal

template<typename >
using std::allocator_traits< typename >::is_always_equal

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 222 of file bits/alloc_traits.h.

◆ pointer

template<typename >
using std::allocator_traits< typename >::pointer

The allocator's pointer type.

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

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

◆ propagate_on_container_copy_assignment

template<typename >
using std::allocator_traits< typename >::propagate_on_container_copy_assignment

How the allocator is propagated on copy assignment.

Alloc::propagate_on_container_copy_assignment if that type exists, otherwise false_type

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

◆ propagate_on_container_move_assignment

template<typename >
using std::allocator_traits< typename >::propagate_on_container_move_assignment

How the allocator is propagated on move assignment.

Alloc::propagate_on_container_move_assignment if that type exists, otherwise false_type

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

◆ propagate_on_container_swap

template<typename >
using std::allocator_traits< typename >::propagate_on_container_swap

How the allocator is propagated on swap.

Alloc::propagate_on_container_swap if that type exists, otherwise false_type

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

◆ rebind_alloc

template<typename >
template<typename _Tp >
using std::allocator_traits< typename >::rebind_alloc

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

◆ rebind_traits

template<typename >
template<typename _Tp >
using std::allocator_traits< typename >::rebind_traits

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

◆ size_type

template<typename >
using std::allocator_traits< typename >::size_type

The allocator's size type.

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

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

◆ value_type

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

The allocated type.

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

◆ void_pointer

template<typename >
using std::allocator_traits< typename >::void_pointer

The allocator's void pointer type.

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

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

Member Function Documentation

◆ allocate() [1/2]

template<typename >
static constexpr pointer std::allocator_traits< typename >::allocate ( _Alloc & __a,
size_type __n )
inlinestaticnodiscardconstexpr

Allocate memory.

Parameters
__aAn allocator.
__nThe number of objects to allocate space for.

Calls a.allocate(n)

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

◆ allocate() [2/2]

template<typename >
static constexpr pointer std::allocator_traits< typename >::allocate ( _Alloc & __a,
size_type __n,
const_void_pointer __hint )
inlinestaticnodiscardconstexpr

Allocate memory.

Parameters
__aAn allocator.
__nThe number of objects to allocate space for.
__hintAid 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 343 of file bits/alloc_traits.h.

◆ construct()

template<typename >
template<typename _Tp , typename... _Args>
static constexpr auto std::allocator_traits< typename >::construct ( _Alloc & __a,
_Tp * __p,
_Args &&... __args ) -> decltype(_S_construct(__a, __p, std::forward<_Args>(__args)...))
inlinestaticconstexprnoexcept

Construct an object of type _Tp

Parameters
__aAn allocator.
__pPointer to memory of suitable size and alignment for Tp
__argsConstructor 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 371 of file bits/alloc_traits.h.

References std::forward().

◆ deallocate()

template<typename >
static constexpr void std::allocator_traits< typename >::deallocate ( _Alloc & __a,
pointer __p,
size_type __n )
inlinestaticconstexpr

Deallocate memory.

Parameters
__aAn allocator.
__pPointer to the memory to deallocate.
__nThe number of objects space was allocated for.

Calls a.deallocate(p, n)

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

◆ destroy()

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

Destroy an object of type _Tp.

Parameters
__aAn allocator.
__pPointer to the object to destroy

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

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

◆ max_size()

template<typename >
static constexpr size_type std::allocator_traits< typename >::max_size ( const _Alloc & __a)
inlinestaticconstexprnoexcept

The maximum supported allocation size.

Parameters
__aAn allocator.
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 400 of file bits/alloc_traits.h.

◆ select_on_container_copy_construction()

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

Obtain an allocator to use when copying a container.

Parameters
__rhsAn allocator.
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 412 of file bits/alloc_traits.h.


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