boost-react-native-bundle

<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Class template list</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="../../intrusive/reference.html#header.boost.intrusive.list_hpp" title="Header <boost/intrusive/list.hpp>"> <link rel="prev" href="link_mode_type.html" title="Type link_mode_type"> <link rel="next" href="make_list.html" title="Struct template make_list"> </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="link_mode_type.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../intrusive/reference.html#header.boost.intrusive.list_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="make_list.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.intrusive.list"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Class template list</h2> boost::intrusive::list </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="../../intrusive/reference.html#header.boost.intrusive.list_hpp" title="Header <boost/intrusive/list.hpp>">boost/intrusive/list.hpp</a>> template<typename T, class... Options> class <a class="link" href="list.html" title="Class template list">list</a> { public: // types typedef ValueTraits <a name="boost.intrusive.list.value_traits"></a>value_traits; typedef value_traits::pointer <a name="boost.intrusive.list.pointer"></a>pointer; typedef value_traits::const_pointer <a name="boost.intrusive.list.const_pointer"></a>const_pointer; typedef <a class="link" href="pointer_traits.html" title="Struct template pointer_traits">pointer_traits</a>< pointer >::element_type <a name="boost.intrusive.list.value_type"></a>value_type; typedef <a class="link" href="pointer_traits.html" title="Struct template pointer_traits">pointer_traits</a>< pointer >::reference <a name="boost.intrusive.list.reference"></a>reference; typedef <a class="link" href="pointer_traits.html" title="Struct template pointer_traits">pointer_traits</a>< const_pointer >::reference <a name="boost.intrusive.list.const_reference"></a>const_reference; typedef <a class="link" href="pointer_traits.html" title="Struct template pointer_traits">pointer_traits</a>< pointer >::difference_type <a name="boost.intrusive.list.difference_type"></a>difference_type; typedef SizeType <a name="boost.intrusive.list.size_type"></a>size_type; typedef list_iterator< value_traits, false > <a name="boost.intrusive.list.iterator"></a>iterator; typedef list_iterator< value_traits, true > <a name="boost.intrusive.list.const_iterator"></a>const_iterator; typedef unspecified <a name="boost.intrusive.list.reverse_iterator"></a>reverse_iterator; typedef unspecified <a name="boost.intrusive.list.const_reverse_iterator"></a>const_reverse_iterator; typedef value_traits::node_traits <a name="boost.intrusive.list.node_traits"></a>node_traits; typedef node_traits::node <a name="boost.intrusive.list.node"></a>node; typedef node_traits::node_ptr <a name="boost.intrusive.list.node_ptr"></a>node_ptr; typedef node_traits::const_node_ptr <a name="boost.intrusive.list.const_node_ptr"></a>const_node_ptr; typedef <a class="link" href="circular_list_algorithms.html" title="Class template circular_list_algorithms">circular_list_algorithms</a>< node_traits > <a name="boost.intrusive.list.node_algorithms"></a>node_algorithms; typedef HeaderHolder <a name="boost.intrusive.list.header_holder_type"></a>header_holder_type; // <a class="link" href="list.html#boost.intrusive.listconstruct-copy-destruct">construct/copy/destruct</a> explicit <a class="link" href="list.html#idp63781632-bb">list</a>(const value_traits & = value_traits()); template<typename Iterator> <a class="link" href="list.html#idp63785952-bb">list</a>(Iterator, Iterator, const value_traits & = value_traits()); <a class="link" href="list.html#idp63793184-bb">list</a>(<a class="link" href="list.html" title="Class template list">list</a> &&); <a class="link" href="list.html" title="Class template list">list</a> & <a class="link" href="list.html#idp63795424-bb">operator=</a>(<a class="link" href="list.html" title="Class template list">list</a> &&); <a class="link" href="list.html#idp63798240-bb">~list</a>(); // <a class="link" href="list.html#idp63431232-bb">public member functions</a> void <a class="link" href="list.html#idp63431792-bb">push_back</a>(reference); void <a class="link" href="list.html#idp63437824-bb">push_front</a>(reference); void <a class="link" href="list.html#idp63443856-bb">pop_back</a>(); template<typename Disposer> void <a class="link" href="list.html#idp63448336-bb">pop_back_and_dispose</a>(Disposer); void <a class="link" href="list.html#idp63455264-bb">pop_front</a>(); template<typename Disposer> void <a class="link" href="list.html#idp63459744-bb">pop_front_and_dispose</a>(Disposer); reference <a class="link" href="list.html#idp63466672-bb">front</a>(); const_reference <a class="link" href="list.html#idp63470224-bb">front</a>() const; reference <a class="link" href="list.html#idp63474064-bb">back</a>(); const_reference <a class="link" href="list.html#idp63477616-bb">back</a>() const; iterator <a class="link" href="list.html#idp63481456-bb">begin</a>(); const_iterator <a class="link" href="list.html#idp63485024-bb">begin</a>() const; const_iterator <a class="link" href="list.html#idp63488864-bb">cbegin</a>() const; iterator <a class="link" href="list.html#idp63492704-bb">end</a>(); const_iterator <a class="link" href="list.html#idp63496256-bb">end</a>() const; const_iterator <a class="link" href="list.html#idp63500080-bb">cend</a>() const; reverse_iterator <a class="link" href="list.html#idp63503904-bb">rbegin</a>(); const_reverse_iterator <a class="link" href="list.html#idp63507488-bb">rbegin</a>() const; const_reverse_iterator <a class="link" href="list.html#idp63511344-bb">crbegin</a>() const; reverse_iterator <a class="link" href="list.html#idp63515200-bb">rend</a>(); const_reverse_iterator <a class="link" href="list.html#idp63518768-bb">rend</a>() const; const_reverse_iterator <a class="link" href="list.html#idp63522624-bb">crend</a>() const; size_type <a class="link" href="list.html#idp63526480-bb">size</a>() const; bool <a class="link" href="list.html#idp63531328-bb">empty</a>() const; void <a class="link" href="list.html#idp63536048-bb">swap</a>(<a class="link" href="list.html" title="Class template list">list</a> &); void <a class="link" href="list.html#idp63541456-bb">shift_backwards</a>(size_type = 1); void <a class="link" href="list.html#idp63547008-bb">shift_forward</a>(size_type = 1); iterator <a class="link" href="list.html#idp63552544-bb">erase</a>(const_iterator); iterator <a class="link" href="list.html#idp63558656-bb">erase</a>(const_iterator, const_iterator); iterator <a class="link" href="list.html#idp63566464-bb">erase</a>(const_iterator, const_iterator, size_type); template<typename Disposer> iterator <a class="link" href="list.html#idp63574960-bb">erase_and_dispose</a>(const_iterator, Disposer); template<typename Disposer> iterator <a class="link" href="list.html#idp63583520-bb">erase_and_dispose</a>(const_iterator, const_iterator, Disposer); void <a class="link" href="list.html#idp63592800-bb">clear</a>(); template<typename Disposer> void <a class="link" href="list.html#idp63597376-bb">clear_and_dispose</a>(Disposer); template<typename Cloner, typename Disposer> void <a class="link" href="list.html#idp63604352-bb">clone_from</a>(const <a class="link" href="list.html" title="Class template list">list</a> &, Cloner, Disposer); iterator <a class="link" href="list.html#idp63613312-bb">insert</a>(const_iterator, reference); template<typename Iterator> void <a class="link" href="list.html#idp63620928-bb">insert</a>(const_iterator, Iterator, Iterator); template<typename Iterator> void <a class="link" href="list.html#idp63629312-bb">assign</a>(Iterator, Iterator); template<typename Iterator, typename Disposer> void <a class="link" href="list.html#idp63637152-bb">dispose_and_assign</a>(Disposer, Iterator, Iterator); void <a class="link" href="list.html#idp63647072-bb">splice</a>(const_iterator, <a class="link" href="list.html" title="Class template list">list</a> &); void <a class="link" href="list.html#idp63654224-bb">splice</a>(const_iterator, <a class="link" href="list.html" title="Class template list">list</a> &, const_iterator); void <a class="link" href="list.html#idp63662208-bb">splice</a>(const_iterator, <a class="link" href="list.html" title="Class template list">list</a> &, const_iterator, const_iterator); void <a class="link" href="list.html#idp63670896-bb">splice</a>(const_iterator, <a class="link" href="list.html" title="Class template list">list</a> &, const_iterator, const_iterator, size_type); void <a class="link" href="list.html#idp63680192-bb">sort</a>(); template<typename Predicate> void <a class="link" href="list.html#idp63684944-bb">sort</a>(Predicate); void <a class="link" href="list.html#idp63692896-bb">merge</a>(<a class="link" href="list.html" title="Class template list">list</a> &); template<typename Predicate> void <a class="link" href="list.html#idp63698608-bb">merge</a>(<a class="link" href="list.html" title="Class template list">list</a> &, Predicate); void <a class="link" href="list.html#idp63706832-bb">reverse</a>(); void <a class="link" href="list.html#idp63711280-bb">remove</a>(const_reference); template<typename Disposer> void <a class="link" href="list.html#idp63716592-bb">remove_and_dispose</a>(const_reference, Disposer); template<typename Pred> void <a class="link" href="list.html#idp63724368-bb">remove_if</a>(Pred); template<typename Pred, typename Disposer> void <a class="link" href="list.html#idp63730528-bb">remove_and_dispose_if</a>(Pred, Disposer); void <a class="link" href="list.html#idp63738864-bb">unique</a>(); template<typename BinaryPredicate> void <a class="link" href="list.html#idp63743504-bb">unique</a>(BinaryPredicate); template<typename Disposer> void <a class="link" href="list.html#idp63749696-bb">unique_and_dispose</a>(Disposer); template<typename BinaryPredicate, typename Disposer> void <a class="link" href="list.html#idp63756816-bb">unique_and_dispose</a>(BinaryPredicate, Disposer); iterator <a class="link" href="list.html#idp63765184-bb">iterator_to</a>(reference); const_iterator <a class="link" href="list.html#idp63771216-bb">iterator_to</a>(const_reference) const; void <a class="link" href="list.html#idp63777520-bb">check</a>() const; // <a class="link" href="list.html#idp63800768-bb">public static functions</a> static <a class="link" href="list.html" title="Class template list">list</a> & <a class="link" href="list.html#idp63801328-bb">container_from_end_iterator</a>(iterator); static const <a class="link" href="list.html" title="Class template list">list</a> & <a class="link" href="list.html#idp63807040-bb">container_from_end_iterator</a>(const_iterator); static iterator <a class="link" href="list.html#idp63812928-bb">s_iterator_to</a>(reference); static const_iterator <a class="link" href="list.html#idp63819728-bb">s_iterator_to</a>(const_reference); // public data members static const bool constant_time_size; static const bool stateful_value_traits; static const bool has_container_from_iterator; };</pre></div> <div class="refsect1"> <a name="idp285297424"></a><h2>Description</h2> The class template list is an intrusive container that mimics most of the interface of std::list as described in the C++ standard. The template parameter <code class="computeroutput">T</code> is the type to be managed by the container. The user can specify additional options and if no options are provided default options are used. The container supports the following options: <code class="computeroutput">base_hook<>/member_hook<>/value_traits<></code>, <code class="computeroutput">constant_time_size<></code> and <code class="computeroutput">size_type<></code>. <div class="refsect2"> <a name="idp285301824"></a><h3> <a name="boost.intrusive.listconstruct-copy-destruct"></a><code class="computeroutput">list</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> <pre class="literallayout">explicit <a name="idp63781632-bb"></a>list(const value_traits & v_traits = value_traits());</pre> Effects: constructs an empty list. Complexity: Constant Throws: If value_traits::node_traits::node constructor throws (this does not happen with predefined Boost.Intrusive hooks). </li> <li class="listitem"> <pre class="literallayout">template<typename Iterator> <a name="idp63785952-bb"></a>list(Iterator b, Iterator e, const value_traits & v_traits = value_traits());</pre> Requires: Dereferencing iterator must yield an lvalue of type value_type. Effects: Constructs a list equal to the range [first,last). Complexity: Linear in std::distance(b, e). No copy constructors are called. Throws: If value_traits::node_traits::node constructor throws (this does not happen with predefined Boost.Intrusive hooks). </li> <li class="listitem"> <pre class="literallayout"><a name="idp63793184-bb"></a>list(<a class="link" href="list.html" title="Class template list">list</a> && x);</pre> Effects: to-do </li> <li class="listitem"> <pre class="literallayout"><a class="link" href="list.html" title="Class template list">list</a> & <a name="idp63795424-bb"></a>operator=(<a class="link" href="list.html" title="Class template list">list</a> && x);</pre> Effects: to-do </li> <li class="listitem"> <pre class="literallayout"><a name="idp63798240-bb"></a>~list();</pre> Effects: If it's not a safe-mode or an auto-unlink value_type the destructor does nothing (ie. no code is generated). Otherwise it detaches all elements from this. In this case the objects in the list are not deleted (i.e. no destructors are called), but the hooks according to the ValueTraits template parameter are set to their default value. Complexity: Linear to the number of elements in the list, if it's a safe-mode or auto-unlink value . Otherwise constant. </li> </ol></div> </div> <div class="refsect2"> <a name="idp285352400"></a><h3> <a name="idp63431232-bb"></a><code class="computeroutput">list</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> <pre class="literallayout">void <a name="idp63431792-bb"></a>push_back(reference value);</pre> Requires: value must be an lvalue. Effects: Inserts the value in the back of the list. No copy constructors are called. Throws: Nothing. Complexity: Constant. Note: Does not affect the validity of iterators and references. </li> <li class="listitem"> <pre class="literallayout">void <a name="idp63437824-bb"></a>push_front(reference value);</pre> Requires: value must be an lvalue. Effects: Inserts the value in the front of the list. No copy constructors are called. Throws: Nothing. Complexity: Constant. Note: Does not affect the validity of iterators and references. </li> <li class="listitem"> <pre class="literallayout">void <a name="idp63443856-bb"></a>pop_back();</pre> Effects: Erases the last element of the list. No destructors are called. Throws: Nothing. Complexity: Constant. Note: Invalidates the iterators (but not the references) to the erased element. </li> <li class="listitem"> <pre class="literallayout">template<typename Disposer> void <a name="idp63448336-bb"></a>pop_back_and_dispose(Disposer disposer);</pre> Requires: Disposer::operator()(pointer) shouldn't throw. Effects: Erases the last element of the list. No destructors are called. Disposer::operator()(pointer) is called for the removed element. Throws: Nothing. Complexity: Constant. Note: Invalidates the iterators to the erased element. </li> <li class="listitem"> <pre class="literallayout">void <a name="idp63455264-bb"></a>pop_front();</pre> Effects: Erases the first element of the list. No destructors are called. Throws: Nothing. Complexity: Constant. Note: Invalidates the iterators (but not the references) to the erased element. </li> <li class="listitem"> <pre class="literallayout">template<typename Disposer> void <a name="idp63459744-bb"></a>pop_front_and_dispose(Disposer disposer);</pre> Requires: Disposer::operator()(pointer) shouldn't throw. Effects: Erases the first element of the list. No destructors are called. Disposer::operator()(pointer) is called for the removed element. Throws: Nothing. Complexity: Constant. Note: Invalidates the iterators to the erased element. </li> <li class="listitem"> <pre class="literallayout">reference <a name="idp63466672-bb"></a>front();</pre> Effects: Returns a reference to the first element of the list. Throws: Nothing. Complexity: Constant. </li> <li class="listitem"> <pre class="literallayout">const_reference <a name="idp63470224-bb"></a>front() const;</pre> Effects: Returns a const_reference to the first element of the list. Throws: Nothing. Complexity: Constant. </li> <li class="listitem"> <pre class="literallayout">reference <a name="idp63474064-bb"></a>back();</pre> Effects: Returns a reference to the last element of the list. Throws: Nothing. Complexity: Constant. </li> <li class="listitem"> <pre class="literallayout">const_reference <a name="idp63477616-bb"></a>back() const;</pre> Effects: Returns a const_reference to the last element of the list. Throws: Nothing. Complexity: Constant. </li> <li class="listitem"> <pre class="literallayout">iterator <a name="idp63481456-bb"></a>begin();</pre> Effects: Returns an iterator to the first element contained in the list. Throws: Nothing. Complexity: Constant. </li> <li class="listitem"> <pre class="literallayout">const_iterator <a name="idp63485024-bb"></a>begin() const;</pre> Effects: Returns a const_iterator to the first element contained in the list. Throws: Nothing. Complexity: Constant. </li> <li class="listitem"> <pre class="literallayout">const_iterator <a name="idp63488864-bb"></a>cbegin() const;</pre> Effects: Returns a const_iterator to the first element contained in the list. Throws: Nothing. Complexity: Constant. </li> <li class="listitem"> <pre class="literallayout">iterator <a name="idp63492704-bb"></a>end();</pre> Effects: Returns an iterator to the end of the list. Throws: Nothing. Complexity: Constant. </li> <li class="listitem"> <pre class="literallayout">const_iterator <a name="idp63496256-bb"></a>end() const;</pre> Effects: Returns a const_iterator to the end of the list. Throws: Nothing. Complexity: Constant. </li> <li class="listitem"> <pre class="literallayout">const_iterator <a name="idp63500080-bb"></a>cend() const;</pre> Effects: Returns a constant iterator to the end of the list. Throws: Nothing. Complexity: Constant. </li> <li class="listitem"> <pre class="literallayout">reverse_i