boost-react-native-bundle

<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Struct template allocator_traits</title> <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../boost_container_header_reference.html#header.boost.container.allocator_traits_hpp" title="Header <boost/container/allocator_traits.hpp>"> <link rel="prev" href="allocator/rebind.html" title="Struct template rebind"> <link rel="next" href="allocator_traits/portable_rebind_alloc.html" title="Struct template portable_rebind_alloc"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> <td align="center"><a href="../../../../index.html">Home</a></td> <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> <td align="center"><a href="../../../../more/index.htm">More</a></td> </tr></table> <hr> <div class="spirit-nav"> <a accesskey="p" href="allocator/rebind.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_container_header_reference.html#header.boost.container.allocator_traits_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="allocator_traits/portable_rebind_alloc.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.container.allocator_traits"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Struct template allocator_traits</h2> boost::container::allocator_traits </div> <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis">// In header: <<a class="link" href="../../boost_container_header_reference.html#header.boost.container.allocator_traits_hpp" title="Header <boost/container/allocator_traits.hpp>">boost/container/allocator_traits.hpp</a>> template<typename Alloc> struct <a class="link" href="allocator_traits.html" title="Struct template allocator_traits">allocator_traits</a> { // <a class="link" href="allocator_traits.html#boost.container.allocator_traitstypes">types</a> typedef Alloc <a name="boost.container.allocator_traits.allocator_type"></a>allocator_type; typedef Alloc::value_type <a name="boost.container.allocator_traits.value_type"></a>value_type; typedef unspecified <a class="link" href="allocator_traits.html#boost.container.allocator_traits.pointer">pointer</a>; typedef see_documentation <a class="link" href="allocator_traits.html#boost.container.allocator_traits.const_pointer">const_pointer</a>; typedef see_documentation <a class="link" href="allocator_traits.html#boost.container.allocator_traits.reference">reference</a>; typedef see_documentation <a class="link" href="allocator_traits.html#boost.container.allocator_traits.const_reference">const_reference</a>; typedef see_documentation <a class="link" href="allocator_traits.html#boost.container.allocator_traits.void_pointer">void_pointer</a>; typedef see_documentation <a class="link" href="allocator_traits.html#boost.container.allocator_traits.const_void_pointer">const_void_pointer</a>; typedef see_documentation <a class="link" href="allocator_traits.html#boost.container.allocator_traits.difference_type">difference_type</a>; typedef see_documentation <a class="link" href="allocator_traits.html#boost.container.allocator_traits.size_type">size_type</a>; typedef see_documentation <a class="link" href="allocator_traits.html#boost.container.allocator_traits.propagate_on_c_idp35983328">propagate_on_container_copy_assignment</a>; typedef see_documentation <a class="link" href="allocator_traits.html#boost.container.allocator_traits.propagate_on_c_idp35985184">propagate_on_container_move_assignment</a>; typedef see_documentation <a class="link" href="allocator_traits.html#boost.container.allocator_traits.propagate_on_c_idp35987040">propagate_on_container_swap</a>; typedef see_documentation <a class="link" href="allocator_traits.html#boost.container.allocator_traits.rebind_alloc">rebind_alloc</a>; typedef <a class="link" href="allocator_traits.html" title="Struct template allocator_traits">allocator_traits</a>< rebind_alloc< T > > <a class="link" href="allocator_traits.html#boost.container.allocator_traits.rebind_traits">rebind_traits</a>; // member classes/structs/unions template<typename T> struct <a class="link" href="allocator_traits/portable_rebind_alloc.html" title="Struct template portable_rebind_alloc">portable_rebind_alloc</a> { // types typedef see_documentation <a class="link" href="allocator_traits/portable_rebind_alloc.html#boost.container.allocator_traits.portable_rebind_alloc.type">type</a>; }; // <a class="link" href="allocator_traits.html#idp35994608-bb">public static functions</a> static pointer <a class="link" href="allocator_traits.html#idp35995168-bb">allocate</a>(Alloc &, size_type); static void <a class="link" href="allocator_traits.html#idp35999088-bb">deallocate</a>(Alloc &, pointer, size_type); static pointer <a class="link" href="allocator_traits.html#idp36004384-bb">allocate</a>(Alloc &, size_type, const_void_pointer); template<typename T> static void <a class="link" href="allocator_traits.html#idp36009472-bb">destroy</a>(Alloc &, T *) noexcept; static size_type <a class="link" href="allocator_traits.html#idp36014992-bb">max_size</a>(const Alloc &) noexcept; static Alloc <a class="link" href="allocator_traits.html#idp36018992-bb">select_on_container_copy_construction</a>(const Alloc &); template<typename T, class... Args> static void <a class="link" href="allocator_traits.html#idp36022304-bb">construct</a>(Alloc &, T *, Args &&...); };</pre></div> <div class="refsect1"> <a name="idp152712848"></a><h2>Description</h2> The class template <a class="link" href="allocator_traits.html" title="Struct template allocator_traits">allocator_traits</a> supplies a uniform interface to all allocator types. This class is a C++03-compatible implementation of std::allocator_traits <div class="refsect2"> <a name="idp152714576"></a><h3> <a name="boost.container.allocator_traitstypes"></a><code class="computeroutput">allocator_traits</code> public types</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> typedef unspecified <a name="boost.container.allocator_traits.pointer"></a>pointer; Alloc::pointer if such a type exists; otherwise, value_type* </li> <li class="listitem"> typedef see_documentation <a name="boost.container.allocator_traits.const_pointer"></a>const_pointer; Alloc::const_pointer if such a type exists ; otherwise, pointer_traits<pointer>::rebind<const </li> <li class="listitem"> typedef see_documentation <a name="boost.container.allocator_traits.reference"></a>reference; Non-standard extension Alloc::reference if such a type exists; otherwise, value_type& </li> <li class="listitem"> typedef see_documentation <a name="boost.container.allocator_traits.const_reference"></a>const_reference; Non-standard extension Alloc::const_reference if such a type exists ; otherwise, const value_type& </li> <li class="listitem"> typedef see_documentation <a name="boost.container.allocator_traits.void_pointer"></a>void_pointer; Alloc::void_pointer if such a type exists ; otherwise, pointer_traits<pointer>::rebind<void>. </li> <li class="listitem"> typedef see_documentation <a name="boost.container.allocator_traits.const_void_pointer"></a>const_void_pointer; Alloc::const_void_pointer if such a type exists ; otherwis e, pointer_traits<pointer>::rebind<const </li> <li class="listitem"> typedef see_documentation <a name="boost.container.allocator_traits.difference_type"></a>difference_type; Alloc::difference_type if such a type exists ; otherwise, pointer_traits<pointer>::difference_type. </li> <li class="listitem"> typedef see_documentation <a name="boost.container.allocator_traits.size_type"></a>size_type; Alloc::size_type if such a type exists ; otherwise, make_unsigned<difference_type>::type </li> <li class="listitem"> typedef see_documentation <a name="boost.container.allocator_traits.propagate_on_c_idp35983328"></a>propagate_on_container_copy_assignment; Alloc::propagate_on_container_copy_assignment if such a type exists, otherwise an integral_constant type with internal constant static member <code class="computeroutput">value</code> == false. </li> <li class="listitem"> typedef see_documentation <a name="boost.container.allocator_traits.propagate_on_c_idp35985184"></a>propagate_on_container_move_assignment; Alloc::propagate_on_container_move_assignment if such a type exists, otherwise an integral_constant type with internal constant static member <code class="computeroutput">value</code> == false. </li> <li class="listitem"> typedef see_documentation <a name="boost.container.allocator_traits.propagate_on_c_idp35987040"></a>propagate_on_container_swap; Alloc::propagate_on_container_swap if such a type exists, otherwise an integral_constant type with internal constant static member <code class="computeroutput">value</code> == false. </li> <li class="listitem"> typedef see_documentation <a name="boost.container.allocator_traits.rebind_alloc"></a>rebind_alloc; Defines an allocator: Alloc::rebind<T>::other if such a type exists; otherwise, Alloc<T, Args> if Alloc is a class template instantiation of the form Alloc<U, Args>, where Args is zero or more type arguments ; otherwise, the instantiation of rebind_alloc is ill-formed. In C++03 compilers <code class="computeroutput">rebind_alloc</code> is a struct derived from an allocator deduced by previously detailed rules. </li> <li class="listitem"> typedef <a class="link" href="allocator_traits.html" title="Struct template allocator_traits">allocator_traits</a>< rebind_alloc< T > > <a name="boost.container.allocator_traits.rebind_traits"></a>rebind_traits; In C++03 compilers <code class="computeroutput">rebind_traits</code> is a struct derived from <code class="computeroutput">allocator_traits<OtherAlloc></code>, where <code class="computeroutput">OtherAlloc</code> is the allocator deduced by rules explained in <code class="computeroutput">rebind_alloc</code>. </li> </ol></div> </div> <div class="refsect2"> <a name="idp152777824"></a><h3> <a name="idp35994608-bb"></a><code class="computeroutput">allocator_traits</code> public static functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> <pre class="literallayout">static pointer <a name="idp35995168-bb"></a>allocate(Alloc & a, size_type n);</pre> Returns: <code class="computeroutput">a.allocate(n)</code> </li> <li class="listitem"> <pre class="literallayout">static void <a name="idp35999088-bb"></a>deallocate(Alloc & a, pointer p, size_type n);</pre> Returns: <code class="computeroutput">a.deallocate(p, n)</code> Throws: Nothing </li> <li class="listitem"> <pre class="literallayout">static pointer <a name="idp36004384-bb"></a>allocate(Alloc & a, size_type n, const_void_pointer p);</pre> Effects: calls <code class="computeroutput">a.allocate(n, p)</code> if that call is well-formed; otherwise, invokes <code class="computeroutput">a.allocate(n)</code> </li> <li class="listitem"> <pre class="literallayout">template<typename T> static void <a name="idp36009472-bb"></a>destroy(Alloc & a, T * p) noexcept;</pre> Effects: calls <code class="computeroutput">a.destroy(p)</code> if that call is well-formed; otherwise, invokes <code class="computeroutput">p->~T()</code>. </li> <li class="listitem"> <pre class="literallayout">static size_type <a name="idp36014992-bb"></a>max_size(const Alloc & a) noexcept;</pre> Returns: <code class="computeroutput">a.max_size()</code> if that expression is well-formed; otherwise, <code class="computeroutput">numeric_limits<size_type>::max()</code>. </li> <li class="listitem"> <pre class="literallayout">static Alloc <a name="idp36018992-bb"></a>select_on_container_copy_construction(const Alloc & a);</pre> Returns: <code class="computeroutput">a.select_on_container_copy_construction()</code> if that expression is well-formed; otherwise, a. </li> <li class="listitem"> <pre class="literallayout">template<typename T, class... Args> static void <a name="idp36022304-bb"></a>construct(Alloc & a, T * p, Args &&... args);</pre> Effects: calls <code class="computeroutput">a.construct(p, std::forward<Args>(args)...)</code> if that call is well-formed; otherwise, invokes <code class="computeroutput">::new (static_cast<void*>(p)) T(std::forward<Args>(args)...)</code> </li> </ol></div> </div> </div> </div> <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> <td align="left"></td> <td align="right"><div class="copyright-footer">Copyright © 2009-2013 Ion Gaztanaga Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) </div></td> </tr></table> <hr> <div class="spirit-nav"> <a accesskey="p" href="allocator/rebind.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_container_header_reference.html#header.boost.container.allocator_traits_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="allocator_traits/portable_rebind_alloc.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html>