libstdc++
std::allocator_traits< _Alloc > Struct Template Reference
Inheritance diagram for std::allocator_traits< _Alloc >:

List of all members.

Public Types

typedef _Alloc allocator_type
typedef __const_pointer const_pointer
typedef __const_void_pointer const_void_pointer
typedef __difference_type difference_type
typedef __pointer pointer
typedef
__propagate_on_container_copy_assignment 
propagate_on_container_copy_assignment
typedef
__propagate_on_container_move_assignment 
propagate_on_container_move_assignment
typedef
__propagate_on_container_swap 
propagate_on_container_swap
typedef __size_type size_type
typedef _Alloc::value_type value_type
typedef __void_pointer void_pointer

Static Public Member Functions

static pointer allocate (_Alloc &__a, size_type __n)
static pointer allocate (_Alloc &__a, size_type __n, const_void_pointer __hint)
template<typename _Tp , typename... _Args>
static void construct (_Alloc &__a, _Tp *__p, _Args &&...__args)
static void deallocate (_Alloc &__a, pointer __p, size_type __n)
template<class _Tp >
static void destroy (_Alloc &__a, _Tp *__p)
static size_type max_size (const _Alloc &__a)
static _Alloc select_on_container_copy_construction (const _Alloc &__rhs)

Detailed Description

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

Uniform interface to all allocator types.

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


Member Typedef Documentation

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

The allocator type.

Reimplemented in __gnu_cxx::__alloc_traits< _Alloc >, and __gnu_cxx::__alloc_traits< _Tp_alloc_type >.

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

template<typename _Alloc>
typedef __const_pointer std::allocator_traits< _Alloc >::const_pointer

The allocator's const pointer type.

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

Reimplemented in __gnu_cxx::__alloc_traits< _Alloc >, and __gnu_cxx::__alloc_traits< _Tp_alloc_type >.

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

template<typename _Alloc>
typedef __const_void_pointer std::allocator_traits< _Alloc >::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 139 of file bits/alloc_traits.h.

template<typename _Alloc>
typedef __difference_type std::allocator_traits< _Alloc >::difference_type

The allocator's difference type.

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

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

template<typename _Alloc>
typedef __pointer std::allocator_traits< _Alloc >::pointer

The allocator's pointer type.

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

Reimplemented in __gnu_cxx::__alloc_traits< _Alloc >, and __gnu_cxx::__alloc_traits< _Tp_alloc_type >.

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

template<typename _Alloc>
typedef __propagate_on_container_copy_assignment std::allocator_traits< _Alloc >::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 173 of file bits/alloc_traits.h.

template<typename _Alloc>
typedef __propagate_on_container_move_assignment std::allocator_traits< _Alloc >::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 185 of file bits/alloc_traits.h.

template<typename _Alloc>
typedef __propagate_on_container_swap std::allocator_traits< _Alloc >::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 196 of file bits/alloc_traits.h.

template<typename _Alloc>
typedef __size_type std::allocator_traits< _Alloc >::size_type

The allocator's size type.

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

Reimplemented in __gnu_cxx::__alloc_traits< _Alloc >, and __gnu_cxx::__alloc_traits< _Tp_alloc_type >.

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

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

The allocated type.

Reimplemented in __gnu_cxx::__alloc_traits< _Alloc >, and __gnu_cxx::__alloc_traits< _Tp_alloc_type >.

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

template<typename _Alloc>
typedef __void_pointer std::allocator_traits< _Alloc >::void_pointer

The allocator's void pointer type.

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

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


Member Function Documentation

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

Allocate memory.

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

Calls a.allocate(n)

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

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

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

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

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

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

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

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

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

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

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

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

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


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