std::allocator_traits

 

C++

Language

Standard Library Headers

Freestanding and hosted implementations

Named requirements

Language support library

Concepts library (C++20)

Diagnostics library

Utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

Filesystem library (C++17)

Technical Specifications

 

Dynamic memory management

Smart pointers unique_ptr (C++11) shared_ptr (C++11) weak_ptr (C++11) auto_ptr (until C++17) owner_less (C++11) enable_shared_from_this (C++11) bad_weak_ptr (C++11) default_delete (C++11) Allocators allocator allocator_traits (C++11) allocator_arg_t (C++11) allocator_arg (C++11) uses_allocator (C++11) uses_allocator_construction_args (C++20) make_obj_using_allocator (C++20) uninitialized_construct_using_allocator (C++20) scoped_allocator_adaptor (C++11) pmr::polymorphic_allocator (C++17) Memory resources pmr::memory_resource (C++17) pmr::get_default_resource (C++17) pmr::set_default_resource (C++17) pmr::new_delete_resource (C++17) pmr::null_memory_resource (C++17) pmr::synchronized_pool_resource (C++17) pmr::unsynchronized_pool_resource (C++17) pmr::monotonic_buffer_resource (C++17) pmr::pool_options (C++17)

Uninitialized storage uninitialized_copy uninitialized_fill uninitialized_move (C++17) uninitialized_default_construct (C++17) uninitialized_value_construct (C++17) destroy (C++17) uninitialized_copy_n (C++11) uninitialized_fill_n uninitialized_move_n (C++17) uninitialized_default_construct_n (C++17) uninitialized_value_construct_n (C++17) destroy_n (C++17) destroy_at (C++17) raw_storage_iterator (until C++20) get_temporary_buffer (until C++20) return_temporary_buffer (until C++20) Garbage collection support declare_reachable (C++11) undeclare_reachable (C++11) declare_no_pointers (C++11) undeclare_no_pointers (C++11) pointer_safety (C++11) get_pointer_safety (C++11) Miscellaneous pointer_traits (C++11) to_address (C++20) addressof (C++11) align (C++11) assume_aligned (C++20) C Library malloc aligned_alloc (C++17) calloc realloc free Low level memory management

 

std::allocator_traits

Member functions

allocator_traits::allocate

allocator_traits::deallocate

allocator_traits::construct

allocator_traits::destroy

allocator_traits::max_size

allocator_traits::select_on_container_copy_construction

 

Defined in header <memory>
template< class Alloc > struct allocator_traits;		(since C++11)

The allocator_traits class template provides the standardized way to access various properties of Allocators. The standard containers and other standard library components access allocators through this template, which makes it possible to use any class type as an allocator, as long as the user-provided specialization of allocator_traits implements all required functionality.

The default, non-specialized, allocator_traits contains the following members:

Member types

Type	Definition
allocator_type	Alloc
value_type	Alloc::value_type
pointer	Alloc::pointer if present, otherwise value_type*
const_pointer	Alloc::const_pointer if present, otherwise std::pointer_traits<pointer>::rebind<const value_type>
void_pointer	Alloc::void_pointer if present, otherwise std::pointer_traits<pointer>::rebind<void>
const_void_pointer	Alloc::const_void_pointer if present, otherwise std::pointer_traits<pointer>::rebind<const void>
difference_type	Alloc::difference_type if present, otherwise std::pointer_traits<pointer>::difference_type
size_type	Alloc::size_type if present, otherwise std::make_unsigned<difference_type>::type
propagate_on_container_copy_assignment	Alloc::propagate_on_container_copy_assignment if present, otherwise std::false_type
propagate_on_container_move_assignment	Alloc::propagate_on_container_move_assignment if present, otherwise std::false_type
propagate_on_container_swap	Alloc::propagate_on_container_swap if present, otherwise std::false_type
is_always_equal(since C++17)	Alloc::is_always_equal if present, otherwise std::is_empty<Alloc>::type

Member alias templates

Type	Definition
rebind_alloc<T>	Alloc::rebind<T>::other if present, otherwise Alloc<T, Args> if this Alloc is Alloc<U, Args>
rebind_traits<T>	std::allocator_traits<rebind_alloc<T>>

Member functions

allocate [static]	allocates uninitialized storage using the allocator (public static member function)
deallocate [static]	deallocates storage using the allocator (public static member function)
construct [static]	constructs an object in the allocated storage (function template)
destroy [static]	destructs an object stored in the allocated storage (function template)
max_size [static]	returns the maximum object size supported by the allocator (public static member function)
select_on_container_copy_construction [static]	obtains the allocator to use after copying a standard container (public static member function)

See also

allocator	the default allocator (class template)
scoped_allocator_adaptor (C++11)	implements multi-level allocator for multi-level containers (class template)
pointer_traits (C++11)	provides information about pointer-like types (class template)