libstdc++
std::allocator_traits< allocator< _Tp > > Struct Template Reference

#include <memory>

Public Types

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

Static Public Member Functions

static constexpr pointer allocate (allocator< _Tp > &__a, size_type __n)
 
static constexpr pointer allocate (allocator< _Tp > &__a, size_type __n, const_void_pointer __hint)
 
static constexpr pointer allocate (allocator_type &__a, size_type __n)
 
static constexpr pointer allocate (allocator_type &__a, size_type __n, const_void_pointer __hint)
 
static constexpr void construct (allocator< _Tp > &__a, _Tp *__p, _Args &&... __args) noexcept(_S_nothrow_construct< _Tp, _Args... >())
 
template<typename _Up, typename... _Args>
static constexpr void construct (allocator_type &__a, _Up *__p, _Args &&... __args) noexcept(__is_nothrow_new_constructible< _Up, _Args... >)
 
static constexpr void deallocate (allocator< _Tp > &__a, pointer __p, size_type __n)
 
static constexpr void deallocate (allocator_type &__a, pointer __p, size_type __n)
 
static constexpr void destroy (allocator< _Tp > &__a, _Tp *__p) noexcept(_S_nothrow_destroy< _Tp >())
 
template<typename _Up>
static constexpr void destroy (allocator_type &__a, _Up *__p) noexcept(is_nothrow_destructible< _Up >::value)
 
static constexpr size_type max_size (const allocator< _Tp > &__a) noexcept
 
static constexpr size_type max_size (const allocator_type &__a) noexcept
 
static constexpr allocator< _Tp > select_on_container_copy_construction (const allocator< _Tp > &__rhs)
 
static constexpr allocator_type select_on_container_copy_construction (const allocator_type &__rhs)
 

Detailed Description

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

Partial specialization for std::allocator

Since
C++11
See also
std::allocator_traits

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

Member Typedef Documentation

◆ allocator_type [1/2]

typedef allocator< _Tp > std::allocator_traits< allocator< _Tp > >::allocator_type

The allocator type.

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

◆ allocator_type [2/2]

template<typename _Tp>
using std::allocator_traits< allocator< _Tp > >::allocator_type

The allocator type.

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

◆ const_pointer [1/2]

using std::allocator_traits< allocator< _Tp > >::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 301 of file bits/alloc_traits.h.

◆ const_pointer [2/2]

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

The allocator's const pointer type.

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

◆ const_void_pointer [1/2]

using std::allocator_traits< allocator< _Tp > >::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 317 of file bits/alloc_traits.h.

◆ const_void_pointer [2/2]

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

The allocator's const void pointer type.

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

◆ difference_type [1/2]

using std::allocator_traits< allocator< _Tp > >::difference_type

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.

◆ difference_type [2/2]

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

The allocator's difference type.

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

◆ is_always_equal [1/2]

using std::allocator_traits< allocator< _Tp > >::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 365 of file bits/alloc_traits.h.

◆ is_always_equal [2/2]

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

Whether all instances of the allocator type compare equal.

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

◆ pointer [1/2]

using std::allocator_traits< allocator< _Tp > >::pointer

The allocator's pointer type.

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

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

◆ pointer [2/2]

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

The allocator's pointer type.

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

◆ propagate_on_container_copy_assignment [1/2]

using std::allocator_traits< allocator< _Tp > >::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 341 of file bits/alloc_traits.h.

◆ propagate_on_container_copy_assignment [2/2]

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

How the allocator is propagated on copy assignment.

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

◆ propagate_on_container_move_assignment [1/2]

using std::allocator_traits< allocator< _Tp > >::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 349 of file bits/alloc_traits.h.

◆ propagate_on_container_move_assignment [2/2]

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

How the allocator is propagated on move assignment.

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

◆ propagate_on_container_swap [1/2]

using std::allocator_traits< allocator< _Tp > >::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 357 of file bits/alloc_traits.h.

◆ propagate_on_container_swap [2/2]

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

How the allocator is propagated on swap.

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

◆ rebind_alloc [1/2]

using std::allocator_traits< allocator< _Tp > >::rebind_alloc

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

◆ rebind_alloc [2/2]

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

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

◆ rebind_traits [1/2]

using std::allocator_traits< allocator< _Tp > >::rebind_traits

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

◆ rebind_traits [2/2]

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

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

◆ size_type [1/2]

using std::allocator_traits< allocator< _Tp > >::size_type

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.

◆ size_type [2/2]

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

The allocator's size type.

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

◆ value_type [1/2]

typedef allocator< _Tp >::value_type std::allocator_traits< allocator< _Tp > >::value_type

The allocated type.

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

◆ value_type [2/2]

template<typename _Tp>
using std::allocator_traits< allocator< _Tp > >::value_type

The allocated type.

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

◆ void_pointer [1/2]

using std::allocator_traits< allocator< _Tp > >::void_pointer

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.

◆ void_pointer [2/2]

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

The allocator's void pointer type.

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

Member Function Documentation

◆ allocate() [1/4]

static constexpr pointer std::allocator_traits< allocator< _Tp > >::allocate ( allocator< _Tp > & __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 380 of file bits/alloc_traits.h.

◆ allocate() [2/4]

static constexpr pointer std::allocator_traits< allocator< _Tp > >::allocate ( allocator< _Tp > & __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 395 of file bits/alloc_traits.h.

◆ allocate() [3/4]

template<typename _Tp>
static constexpr pointer std::allocator_traits< allocator< _Tp > >::allocate ( allocator_type & __a,
size_type __n )
inlinestaticconstexpr

Allocate memory.

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

Calls a.allocate(n)

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

◆ allocate() [4/4]

template<typename _Tp>
static constexpr pointer std::allocator_traits< allocator< _Tp > >::allocate ( allocator_type & __a,
size_type __n,
const_void_pointer __hint )
inlinestaticconstexpr

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)

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

◆ construct() [1/2]

static constexpr void std::allocator_traits< allocator< _Tp > >::construct ( allocator< _Tp > & __a,
_Tp * __p,
_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 433 of file bits/alloc_traits.h.

◆ construct() [2/2]

template<typename _Tp>
template<typename _Up, typename... _Args>
static constexpr void std::allocator_traits< allocator< _Tp > >::construct ( allocator_type & __a,
_Up * __p,
_Args &&... __args )
inlinestaticconstexprnoexcept

Construct an object of type _Up

Parameters
__aAn allocator.
__pPointer to memory of suitable size and alignment for an object of type _Up.
__argsConstructor arguments.

Calls __a.construct(__p, std::forward<_Args>(__args)...) in C++11, C++14 and C++17. Changed in C++20 to call std::construct_at(__p, std::forward<_Args>(__args)...) instead.

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

References std::_Construct(), and std::forward().

◆ deallocate() [1/2]

static constexpr void std::allocator_traits< allocator< _Tp > >::deallocate ( allocator< _Tp > & __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 412 of file bits/alloc_traits.h.

◆ deallocate() [2/2]

template<typename _Tp>
static constexpr void std::allocator_traits< allocator< _Tp > >::deallocate ( allocator_type & __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 648 of file bits/alloc_traits.h.

◆ destroy() [1/2]

static constexpr void std::allocator_traits< allocator< _Tp > >::destroy ( allocator< _Tp > & __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 452 of file bits/alloc_traits.h.

◆ destroy() [2/2]

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

Destroy an object of type _Up.

Parameters
__aAn allocator.
__pPointer to the object to destroy

Calls __a.destroy(__p).

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

◆ max_size() [1/2]

static constexpr size_type std::allocator_traits< allocator< _Tp > >::max_size ( const allocator< _Tp > & __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 470 of file bits/alloc_traits.h.

◆ max_size() [2/2]

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

The maximum supported allocation size.

Parameters
__aAn allocator.
Returns
__a.max_size()

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

◆ select_on_container_copy_construction() [1/2]

static constexpr allocator< _Tp > std::allocator_traits< allocator< _Tp > >::select_on_container_copy_construction ( const allocator< _Tp > & __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 490 of file bits/alloc_traits.h.

◆ select_on_container_copy_construction() [2/2]

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

Obtain an allocator to use when copying a container.

Parameters
__rhsAn allocator.
Returns
__rhs

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


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