logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

__gnu_cxx::__alloc_traits.3cxx

Author

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

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

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.

Member Function Documentation

template<typename_Alloc>staticconstexprpointerstd::allocator_traits<_Alloc>::allocate(_Alloc&__a,size_type__n)[inline],[static],[constexpr],[inherited]
       Allocate memory.

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

       Calls a.allocate(n)

   template<typename_Alloc,typename=typename_Alloc::value_type>staticconstexprpointerstd::allocator_traits<_Alloc>::allocate(_Alloc&__a,size_type__n)[inline],[static],[constexpr]

       Allocate memory.

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

       Calls a.allocate(n)

   template<typename_Alloc>staticconstexprpointerstd::allocator_traits<_Alloc>::allocate(_Alloc&__a,size_type__n,const_void_pointer__hint)[inline],[static],[constexpr],[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)

   template<typename_Alloc,typename=typename_Alloc::value_type>staticconstexprpointerstd::allocator_traits<_Alloc>::allocate(_Alloc&__a,size_type__n,const_void_pointer__hint)[inline],[static],[constexpr]
       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)

   template<typename_Alloc,typename=typename_Alloc::value_type>template<typename_Tp,typename..._Args>staticconstexprautostd::allocator_traits<_Alloc>::construct(_Alloc&__a,_Tp*__p,_Args&&...__args)->decltype(_S_construct(__a,__p,std::forward<_Args>(__args)...))
             [inline],  [static],  [constexpr],  [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...

   template<typename_Alloc>staticconstexprvoidstd::allocator_traits<_Alloc>::deallocate(_Alloc&__a,pointer__p,size_type__n)[inline],[static],[constexpr],[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)

   template<typename_Alloc,typename=typename_Alloc::value_type>staticconstexprvoidstd::allocator_traits<_Alloc>::deallocate(_Alloc&__a,pointer__p,size_type__n)[inline],[static],[constexpr]
       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)

   template<typename_Alloc,typename=typename_Alloc::value_type>template<typename_Tp>staticconstexprvoidstd::allocator_traits<_Alloc>::destroy(_Alloc&__a,_Tp*__p)[inline],[static],[constexpr],[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()

   template<typename_Alloc,typename=typename_Alloc::value_type>staticconstexprsize_typestd::allocator_traits<_Alloc>::max_size(const_Alloc&__a)[inline],[static],[constexpr],[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()

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

   template<typename_Alloc>staticconstexpr_Allocstd::allocator_traits<_Alloc>::select_on_container_copy_construction(const_Alloc&__rhs)[inline],[static],[constexpr],[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

Member Typedef Documentation

template<typename_Alloc>usingstd::allocator_traits<_Alloc>::const_void_pointer=typename_Ptr<__cv_pointer,constvoid>::type[inherited]
       The allocator's const void pointer type. Alloc::const_void_pointer if that type exists, otherwise
       pointer_traits<pointer>::rebind<const void>

   template<typename_Alloc>usingstd::allocator_traits<_Alloc>::is_always_equal=typename__detected_or_t<is_empty<_Alloc>,__equal,_Alloc>::type[inherited]
       Whether all instances of the allocator type compare equal. Alloc::is_always_equal if that type exists,
       otherwise is_empty<Alloc>::type

   template<typename_Alloc>usingstd::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

   template<typename_Alloc>usingstd::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

   template<typename_Alloc>usingstd::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

   template<typename_Alloc>usingstd::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>

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>.

   PublicTypes
       typedef std::allocator_traits< _Alloc > _Base_type
       typedef _Alloc allocator_type
       typedef _Base_type::const_pointerconst_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_typedifference_type
       using is_always_equal = typename __detected_or_t< is_empty< _Alloc >, __equal, _Alloc >::type
           Whether all instances of the allocator type compare equal.
       typedef _Base_type::pointerpointer
       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_typesize_type
       typedef _Base_type::value_typevalue_type
       using void_pointer = typename _Ptr< __v_pointer, void >::type
           The allocator's void pointer type.

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

See Also