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

std::allocator_traits< _Alloc > - Uniform interface to all allocator types.

Author

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

                                                    libstdc++              std::allocator_traits<_Alloc>(3cxx)

Detailed Description

template<typename_Alloc>
       struct std::allocator_traits< _Alloc >"Uniform interface to all allocator types.

       Since
           C++11

Member Function Documentation

template<typename_Alloc>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]
       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>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]
       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>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>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()

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

   template<typename_Alloc>usingstd::allocator_traits<_Alloc>::const_pointer=typename_Ptr<__c_pointer,constvalue_type>::type
       The allocator's const pointer type. Alloc::const_pointer if that type exists, otherwise
       pointer_traits<pointer>::rebind<const value_type>

   template<typename_Alloc>usingstd::allocator_traits<_Alloc>::const_void_pointer=typename_Ptr<__cv_pointer,constvoid>::type
       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>::difference_type=typename_Diff<_Alloc,pointer>::type
       The allocator's difference type. Alloc::difference_type if that type exists, otherwise
       pointer_traits<pointer>::difference_type

   template<typename_Alloc>usingstd::allocator_traits<_Alloc>::is_always_equal=typename__detected_or_t<is_empty<_Alloc>,__equal,_Alloc>::type
       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>::pointer=__detected_or_t<value_type*,__pointer,_Alloc>
       The allocator's pointer type. Alloc::pointer if that type exists, otherwise value_type*

   template<typename_Alloc>usingstd::allocator_traits<_Alloc>::propagate_on_container_copy_assignment=__detected_or_t<false_type,__pocca,_Alloc>
       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>
       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>
       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>::size_type=typename_Size<_Alloc,difference_type>::type
       The allocator's size type. Alloc::size_type if that type exists, otherwise
       make_unsigned<difference_type>::type

   template<typename_Alloc>typedef_Alloc::value_typestd::allocator_traits<_Alloc>::value_type
       The allocated type.

   template<typename_Alloc>usingstd::allocator_traits<_Alloc>::void_pointer=typename_Ptr<__v_pointer,void>::type
       The allocator's void pointer type. Alloc::void_pointer if that type exists, otherwise
       pointer_traits<pointer>::rebind<void>

Name

       std::allocator_traits< _Alloc > - Uniform interface to all allocator types.

Synopsis

       #include <memory>

       Inherits __allocator_traits_base.

       Inherited by __gnu_cxx::__alloc_traits<_Tp_alloc_type>, and __gnu_cxx::__alloc_traits<_Alloc,typename>.

   PublicTypestypedef _Alloc allocator_type
           The allocator type.
       usingconst_pointer = typename _Ptr< __c_pointer, const value_type >::type
           The allocator's const pointer type.
       usingconst_void_pointer = typename _Ptr< __cv_pointer, const void >::type
           The allocator's const void pointer type.
       usingdifference_type = typename _Diff< _Alloc, pointer >::type
           The allocator's difference type.
       usingis_always_equal = typename__detected_or_t< is_empty< _Alloc >, __equal, _Alloc >::type
           Whether all instances of the allocator type compare equal.
       usingpointer = __detected_or_t< value_type *, __pointer, _Alloc >
           The allocator's pointer type.
       usingpropagate_on_container_copy_assignment = __detected_or_t< false_type, __pocca, _Alloc >
           How the allocator is propagated on copy assignment.
       usingpropagate_on_container_move_assignment = __detected_or_t< false_type, __pocma, _Alloc >
           How the allocator is propagated on move assignment.
       usingpropagate_on_container_swap = __detected_or_t< false_type, __pocs, _Alloc >
           How the allocator is propagated on swap.
       template<typename _Tp > usingrebind_alloc = __alloc_rebind< _Alloc, _Tp >
       template<typename _Tp > usingrebind_traits = allocator_traits< rebind_alloc< _Tp > >
       usingsize_type = typename _Size< _Alloc, difference_type >::type
           The allocator's size type.
       typedef _Alloc::value_type value_type
           The allocated type.
       usingvoid_pointer = typename _Ptr< __v_pointer, void >::type
           The allocator's void pointer type.

   StaticPublicMemberFunctionsstatic constexpr pointerallocate (_Alloc &__a, size_type __n)
           Allocate memory.
       static constexpr pointerallocate (_Alloc &__a, size_type __n, const_void_pointer__hint)
           Allocate memory.
       template<typename _Tp , typename... _Args> static constexpr autoconstruct (_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 voiddeallocate (_Alloc &__a, pointer __p, size_type __n)
           Deallocate memory.
       template<typename _Tp > static constexpr voiddestroy (_Alloc &__a, _Tp *__p)
           noexcept(noexcept(_S_destroy(__a, __p, 0)))
           Destroy an object of type _Tp.
       static constexpr size_typemax_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