Provided by: libstdc++-9-doc_9.5.0-3ubuntu1_all bug

NAME

       __gnu_cxx::__alloc_traits< _Alloc, typename > - Uniform interface to C++98 and C++11
       allocators.

SYNOPSIS

       #include <alloc_traits.h>

       Inherits std::allocator_traits< _Alloc >.

   Public Types
       typedef std::allocator_traits< _Alloc > _Base_type
       typedef _Alloc allocator_type
       typedef _Base_type::const_pointer const_pointer
       typedef const value_type & const_reference
       using const_void_pointer = typename _Ptr< __cv_pointer, const void >::type
           The allocator's const void pointer type.
       typedef _Base_type::difference_type difference_type
       using is_always_equal = __detected_or_t< typename is_empty< _Alloc >::type, __equal,
           _Alloc >
           Whether all instances of the allocator type compare equal.
       typedef _Base_type::pointer pointer
       using propagate_on_container_copy_assignment = __detected_or_t< false_type, __pocca,
           _Alloc >
           How the allocator is propagated on copy assignment.
       using propagate_on_container_move_assignment = __detected_or_t< false_type, __pocma,
           _Alloc >
           How the allocator is propagated on move assignment.
       using propagate_on_container_swap = __detected_or_t< false_type, __pocs, _Alloc >
           How the allocator is propagated on swap.
       template<typename _Tp > using rebind_alloc = __alloc_rebind< _Alloc, _Tp >
       template<typename _Tp > using rebind_traits = allocator_traits< rebind_alloc< _Tp > >
       typedef value_type & reference
       typedef _Base_type::size_type size_type
       typedef _Base_type::value_type value_type
       using void_pointer = typename _Ptr< __v_pointer, void >::type
           The allocator's void pointer type.

   Static Public Member Functions
       static constexpr bool _S_always_equal ()
       static constexpr bool _S_nothrow_move ()
       static void _S_on_swap (_Alloc &__a, _Alloc &__b)
       static constexpr bool _S_propagate_on_copy_assign ()
       static constexpr bool _S_propagate_on_move_assign ()
       static constexpr bool _S_propagate_on_swap ()
       static _Alloc _S_select_on_copy (const _Alloc &__a)
       static _GLIBCXX_NODISCARD pointer allocate (_Alloc &__a, size_type __n)
           Allocate memory.
       static _GLIBCXX_NODISCARD pointer allocate (_Alloc &__a, size_type __n)
           Allocate memory.
       static _GLIBCXX_NODISCARD pointer allocate (_Alloc &__a, size_type __n, const_void_pointer
           __hint)
           Allocate memory.
       static _GLIBCXX_NODISCARD pointer allocate (_Alloc &__a, size_type __n, const_void_pointer
           __hint)
           Allocate memory.
       template<typename _Ptr , typename... _Args> static std::enable_if< __is_custom_pointer<
           _Ptr >::value >::type construct (_Alloc &__a, _Ptr __p, _Args &&... __args)
           noexcept(noexcept(_Base_type::construct(__a, std::__to_address(__p), std::forward<
           _Args >(__args)...)))
       template<typename _Tp , typename... _Args> static 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)...))
           Construct an object of type `_Tp`.
       static void deallocate (_Alloc &__a, pointer __p, size_type __n)
           Deallocate memory.
       static void deallocate (_Alloc &__a, pointer __p, size_type __n)
           Deallocate memory.
       template<typename _Ptr > static std::enable_if< __is_custom_pointer< _Ptr >::value >::type
           destroy (_Alloc &__a, _Ptr __p) noexcept(noexcept(_Base_type::destroy(__a,
           std::__to_address(__p))))
       template<typename _Tp > static void destroy (_Alloc &__a, _Tp *__p)
           noexcept(noexcept(_S_destroy(__a, __p, 0)))
           Destroy an object of type _Tp.
       static size_type max_size (const _Alloc &__a) noexcept
           The maximum supported allocation size.
       static _Alloc select_on_container_copy_construction (const _Alloc &__rhs)
           Obtain an allocator to use when copying a container.

   Protected Types
       template<typename _Tp > using __c_pointer = typename _Tp::const_pointer
       template<typename _Tp > using __cv_pointer = typename _Tp::const_void_pointer
       template<typename _Tp > using __equal = typename _Tp::is_always_equal
       template<typename _Tp > using __pocca = typename
           _Tp::propagate_on_container_copy_assignment
       template<typename _Tp > using __pocma = typename
           _Tp::propagate_on_container_move_assignment
       template<typename _Tp > using __pocs = typename _Tp::propagate_on_container_swap
       template<typename _Tp > using __pointer = typename _Tp::pointer
       template<typename _Tp > using __v_pointer = typename _Tp::void_pointer

Detailed Description

   template<typename _Alloc, typename = typename _Alloc::value_type>
       struct __gnu_cxx::__alloc_traits< _Alloc, typename >"Uniform interface to C++98 and C++11
       allocators.

       Definition at line 50 of file ext/alloc_traits.h.

Member Typedef Documentation

   template<typename _Tp > using std::__allocator_traits_base::__c_pointer =  typename
       _Tp::const_pointer [protected],  [inherited]
       Definition at line 59 of file bits/alloc_traits.h.

   template<typename _Tp > using std::__allocator_traits_base::__cv_pointer =  typename
       _Tp::const_void_pointer [protected],  [inherited]
       Definition at line 63 of file bits/alloc_traits.h.

   template<typename _Tp > using std::__allocator_traits_base::__equal =  typename
       _Tp::is_always_equal [protected],  [inherited]
       Definition at line 71 of file bits/alloc_traits.h.

   template<typename _Tp > using std::__allocator_traits_base::__pocca =  typename
       _Tp::propagate_on_container_copy_assignment [protected],  [inherited]
       Definition at line 65 of file bits/alloc_traits.h.

   template<typename _Tp > using std::__allocator_traits_base::__pocma =  typename
       _Tp::propagate_on_container_move_assignment [protected],  [inherited]
       Definition at line 67 of file bits/alloc_traits.h.

   template<typename _Tp > using std::__allocator_traits_base::__pocs =  typename
       _Tp::propagate_on_container_swap [protected],  [inherited]
       Definition at line 69 of file bits/alloc_traits.h.

   template<typename _Tp > using std::__allocator_traits_base::__pointer =  typename _Tp::pointer
       [protected],  [inherited]
       Definition at line 57 of file bits/alloc_traits.h.

   template<typename _Tp > using std::__allocator_traits_base::__v_pointer =  typename
       _Tp::void_pointer [protected],  [inherited]
       Definition at line 61 of file bits/alloc_traits.h.

   template<typename _Alloc , typename  = typename _Alloc::value_type> typedef
       std::allocator_traits<_Alloc> __gnu_cxx::__alloc_traits< _Alloc, typename >::_Base_type
       Definition at line 57 of file ext/alloc_traits.h.

   template<typename _Alloc , typename  = typename _Alloc::value_type> typedef _Alloc
       __gnu_cxx::__alloc_traits< _Alloc, typename >::allocator_type
       Definition at line 55 of file ext/alloc_traits.h.

   template<typename _Alloc , typename  = typename _Alloc::value_type> typedef
       _Base_type::const_pointer __gnu_cxx::__alloc_traits< _Alloc, typename >::const_pointer
       Definition at line 60 of file ext/alloc_traits.h.

   template<typename _Alloc , typename  = typename _Alloc::value_type> typedef const value_type&
       __gnu_cxx::__alloc_traits< _Alloc, typename >::const_reference
       Definition at line 65 of file ext/alloc_traits.h.

   template<typename _Alloc > using std::allocator_traits< _Alloc >::const_void_pointer =
       typename _Ptr<__cv_pointer, const void>::type [inherited]
       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 151 of file bits/alloc_traits.h.

   template<typename _Alloc , typename  = typename _Alloc::value_type> typedef
       _Base_type::difference_type __gnu_cxx::__alloc_traits< _Alloc, typename >::difference_type
       Definition at line 62 of file ext/alloc_traits.h.

   template<typename _Alloc > using std::allocator_traits< _Alloc >::is_always_equal =
       __detected_or_t<typename is_empty<_Alloc>::type, __equal, _Alloc> [inherited]
       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 202 of file bits/alloc_traits.h.

   template<typename _Alloc , typename  = typename _Alloc::value_type> typedef
       _Base_type::pointer __gnu_cxx::__alloc_traits< _Alloc, typename >::pointer
       Definition at line 59 of file ext/alloc_traits.h.

   template<typename _Alloc > using std::allocator_traits< _Alloc
       >::propagate_on_container_copy_assignment =  __detected_or_t<false_type, __pocca, _Alloc>
       [inherited]
       How the allocator is propagated on copy assignment.
       Alloc::propagate_on_container_copy_assignment if that type exists, otherwise false_type

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

   template<typename _Alloc > using std::allocator_traits< _Alloc
       >::propagate_on_container_move_assignment =  __detected_or_t<false_type, __pocma, _Alloc>
       [inherited]
       How the allocator is propagated on move assignment.
       Alloc::propagate_on_container_move_assignment if that type exists, otherwise false_type

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

   template<typename _Alloc > using std::allocator_traits< _Alloc >::propagate_on_container_swap
       =  __detected_or_t<false_type, __pocs, _Alloc> [inherited]
       How the allocator is propagated on swap. Alloc::propagate_on_container_swap if that type
       exists, otherwise false_type

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

   template<typename _Alloc > template<typename _Tp > using std::allocator_traits< _Alloc
       >::rebind_alloc =  __alloc_rebind<_Alloc, _Tp> [inherited]
       Definition at line 206 of file bits/alloc_traits.h.

   template<typename _Alloc > template<typename _Tp > using std::allocator_traits< _Alloc
       >::rebind_traits =  allocator_traits<rebind_alloc<_Tp> > [inherited]
       Definition at line 208 of file bits/alloc_traits.h.

   template<typename _Alloc , typename  = typename _Alloc::value_type> typedef value_type&
       __gnu_cxx::__alloc_traits< _Alloc, typename >::reference
       Definition at line 64 of file ext/alloc_traits.h.

   template<typename _Alloc , typename  = typename _Alloc::value_type> typedef
       _Base_type::size_type __gnu_cxx::__alloc_traits< _Alloc, typename >::size_type
       Definition at line 61 of file ext/alloc_traits.h.

   template<typename _Alloc , typename  = typename _Alloc::value_type> typedef
       _Base_type::value_type __gnu_cxx::__alloc_traits< _Alloc, typename >::value_type
       Definition at line 58 of file ext/alloc_traits.h.

   template<typename _Alloc > using std::allocator_traits< _Alloc >::void_pointer =  typename
       _Ptr<__v_pointer, void>::type [inherited]
       The allocator's void pointer type. Alloc::void_pointer if that type exists, otherwise
       pointer_traits<pointer>::rebind<void>

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

Member Function Documentation

   template<typename _Alloc , typename  = typename _Alloc::value_type> static constexpr bool
       __gnu_cxx::__alloc_traits< _Alloc, typename >::_S_always_equal () [inline],  [static],
       [constexpr]
       Definition at line 112 of file ext/alloc_traits.h.

   template<typename _Alloc , typename  = typename _Alloc::value_type> static constexpr bool
       __gnu_cxx::__alloc_traits< _Alloc, typename >::_S_nothrow_move () [inline],  [static],
       [constexpr]
       Definition at line 115 of file ext/alloc_traits.h.

   template<typename _Alloc , typename  = typename _Alloc::value_type> static void
       __gnu_cxx::__alloc_traits< _Alloc, typename >::_S_on_swap (_Alloc & __a, _Alloc & __b)
       [inline],  [static]
       Definition at line 100 of file ext/alloc_traits.h.

   template<typename _Alloc , typename  = typename _Alloc::value_type> static constexpr bool
       __gnu_cxx::__alloc_traits< _Alloc, typename >::_S_propagate_on_copy_assign () [inline],
       [static],  [constexpr]
       Definition at line 103 of file ext/alloc_traits.h.

   template<typename _Alloc , typename  = typename _Alloc::value_type> static constexpr bool
       __gnu_cxx::__alloc_traits< _Alloc, typename >::_S_propagate_on_move_assign () [inline],
       [static],  [constexpr]
       Definition at line 106 of file ext/alloc_traits.h.

   template<typename _Alloc , typename  = typename _Alloc::value_type> static constexpr bool
       __gnu_cxx::__alloc_traits< _Alloc, typename >::_S_propagate_on_swap () [inline],
       [static],  [constexpr]
       Definition at line 109 of file ext/alloc_traits.h.

   template<typename _Alloc , typename  = typename _Alloc::value_type> static _Alloc
       __gnu_cxx::__alloc_traits< _Alloc, typename >::_S_select_on_copy (const _Alloc & __a)
       [inline],  [static]
       Definition at line 97 of file ext/alloc_traits.h.

   template<typename _Alloc > static _GLIBCXX_NODISCARD pointer std::allocator_traits< _Alloc
       >::allocate (_Alloc & __a, size_type __n) [inline],  [static],  [inherited]
       Allocate memory.

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

       Calls a.allocate(n)

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

       Referenced by std::__allocate_guarded().

   template<typename _Alloc , typename  = typename _Alloc::value_type> static _GLIBCXX_NODISCARD
       pointer std::allocator_traits< _Alloc >::allocate (_Alloc & __a, size_type __n) [inline],
       [static]
       Allocate memory.

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

       Calls a.allocate(n)

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

   template<typename _Alloc > static _GLIBCXX_NODISCARD pointer std::allocator_traits< _Alloc
       >::allocate (_Alloc & __a, size_type __n, const_void_pointer __hint) [inline],  [static],
       [inherited]
       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 319 of file bits/alloc_traits.h.

   template<typename _Alloc , typename  = typename _Alloc::value_type> static _GLIBCXX_NODISCARD
       pointer std::allocator_traits< _Alloc >::allocate (_Alloc & __a, size_type __n,
       const_void_pointer __hint) [inline],  [static]
       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 319 of file bits/alloc_traits.h.

   template<typename _Alloc , typename  = typename _Alloc::value_type> template<typename _Ptr ,
       typename... _Args> static std::enable_if< __is_custom_pointer< _Ptr >::value >::type
       __gnu_cxx::__alloc_traits< _Alloc, typename >::construct (_Alloc & __a, _Ptr __p, _Args
       &&... __args) [inline],  [static],  [noexcept]
       Definition at line 82 of file ext/alloc_traits.h.

   template<typename _Alloc , typename  = typename _Alloc::value_type> template<typename _Tp ,
       typename... _Args> static auto std::allocator_traits< _Alloc >::construct (_Alloc & __a,
       _Tp * __p, _Args &&... __args) -> decltype(_S_construct(__a, __p,
       std::forward<_Args>(__args)...))
             [inline],  [static],  [noexcept]"

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

   template<typename _Alloc > static void std::allocator_traits< _Alloc >::deallocate (_Alloc &
       __a, pointer __p, size_type __n) [inline],  [static],  [inherited]
       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 331 of file bits/alloc_traits.h.

       Referenced by std::__allocated_ptr< _Alloc >::~__allocated_ptr().

   template<typename _Alloc , typename  = typename _Alloc::value_type> static void
       std::allocator_traits< _Alloc >::deallocate (_Alloc & __a, pointer __p, size_type __n)
       [inline],  [static]
       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 331 of file bits/alloc_traits.h.

   template<typename _Alloc , typename  = typename _Alloc::value_type> template<typename _Ptr >
       static std::enable_if< __is_custom_pointer< _Ptr >::value >::type
       __gnu_cxx::__alloc_traits< _Alloc, typename >::destroy (_Alloc & __a, _Ptr __p) [inline],
       [static],  [noexcept]
       Definition at line 93 of file ext/alloc_traits.h.

   template<typename _Alloc , typename  = typename _Alloc::value_type> template<typename _Tp >
       static void std::allocator_traits< _Alloc >::destroy (_Alloc & __a, _Tp * __p) [inline],
       [static],  [noexcept]
       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 361 of file bits/alloc_traits.h.

   template<typename _Alloc , typename  = typename _Alloc::value_type> static size_type
       std::allocator_traits< _Alloc >::max_size (const _Alloc & __a) [inline],  [static],
       [noexcept]
       The maximum supported allocation size.

       Parameters
           __a An 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 373 of file bits/alloc_traits.h.

       Referenced by std::forward_list< _Tp, _Alloc >::max_size(), and std::list< _Tp, _Alloc
       >::max_size().

   template<typename _Alloc > static _Alloc std::allocator_traits< _Alloc
       >::select_on_container_copy_construction (const _Alloc & __rhs) [inline],  [static],
       [inherited]
       Obtain an allocator to use when copying a container.

       Parameters
           __rhs An 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 385 of file bits/alloc_traits.h.

Author

       Generated automatically by Doxygen for libstdc++ from the source code.

libstdc++                                Tue Febgnu_cxx::__alloc_traits< _Alloc, typename >(3cxx)