boost-react-native-bundle

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0.1 Transitional//EN"> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> <title>Boost.MultiIndex Documentation - multi_index_container reference</title> <link rel="stylesheet" href="../style.css" type="text/css"> <link rel="start" href="../index.html"> <link rel="prev" href="index.html"> <link rel="up" href="index.html"> <link rel="next" href="indices.html"> </head> <body> <h1><img src="../../../../boost.png" alt="boost.png (6897 bytes)" align= "middle" width="277" height="86">Boost.MultiIndex <code>multi_index_container</code> reference</h1> <div class="prev_link"><a href="index.html"><img src="../prev.gif" alt="Boost.MultiIndex reference" border="0"> Boost.MultiIndex reference </a></div> <div class="up_link"><a href="index.html"><img src="../up.gif" alt="Boost.MultiIndex reference" border="0"> Boost.MultiIndex reference </a></div> <div class="next_link"><a href="indices.html"><img src="../next.gif" alt="index reference" border="0"> Index reference </a></div> <hr> <h2>Contents</h2> <ul> <li><a href="#multi_index_container_fwd_synopsis">Header <code>"boost/multi_index_container_fwd.hpp"</code> synopsis</a></li> <li><a href="#synopsis">Header <code>"boost/multi_index_container.hpp"</code> synopsis</a> <ul> <li><a href="#multi_index_container">Class template <code>multi_index_container</code></a> <ul> <li><a href="#complexity">Complexity</a></li> <li><a href="#instantiation_types">Instantiation types</a></li> <li><a href="#types">Nested types</a></li> <li><a href="#nested_templates">Nested class templates</a></li> <li><a href="#constructors">Constructors, copy and assignment</a></li> <li><a href="#index_retrieval">Index retrieval operations</a></li> <li><a href="#projection">Projection operations</a></li> <li><a href="#serialization">Serialization</a></li> </ul> </li> </ul> </li> </ul> <h2> <a name="multi_index_container_fwd_synopsis">Header <a href="../../../../boost/multi_index_container_fwd.hpp"><code>"boost/multi_index_container_fwd.hpp"</code></a> synopsis</a> </h2> <blockquote><pre> namespace boost{ namespace multi_index{ template< typename Value, typename IndexSpecifierList=indexed_by<ordered_unique<identity<Value> > >, typename Allocator=std::allocator<Value> > class multi_index_container; } // namespace boost::multi_index using multi_index::multi_index_container; } // namespace boost </pre></blockquote> <code>multi_index_container_fwd.hpp</code> forward declares the class template <a href="#multi_index_container"><code>multi_index_container</code></a> and specifies its default parameters. <h2> <a name="synopsis">Header <a href="../../../../boost/multi_index_container.hpp"><code>"boost/multi_index_container.hpp"</code></a> synopsis</a> </h2> <blockquote><pre> #include <initializer_list> namespace boost{ namespace multi_index{ template<typename Value,typename IndexSpecifierList,typename Allocator> class multi_index_container; // multi_index_container associated global class templates: template<typename MultiIndexContainer,int N> struct nth_index; template<typename MultiIndexContainer,typename Tag> struct index; template<typename MultiIndexContainer,int N> struct nth_index_iterator; // deprecated template<typename MultiIndexContainer,int N> struct nth_index_const_iterator; // deprecated template<typename MultiIndexContainer,typename Tag> struct index_iterator; // deprecated template<typename MultiIndexContainer,typename Tag> struct index_const_iterator; // deprecated // multi_index_container global functions for index retrieval: template< int N,typename Value,typename IndexSpecifierList,typename Allocator > typename nth_index< multi_index_container<Value,IndexSpecifierList,Allocator>,N >::type& get(multi_index_container<Value,IndexSpecifierList,Allocator>& m)noexcept; template< int N,typename Value,typename IndexSpecifierList,typename Allocator > const typename nth_index< multi_index_container<Value,IndexSpecifierList,Allocator>,N >::type& get(const multi_index_container<Value,IndexSpecifierList,Allocator>& m)noexcept; template< typename Tag,typename Value,typename IndexSpecifierList,typename Allocator > typename index< multi_index_container<Value,IndexSpecifierList,Allocator>,Tag >::type& get(multi_index_container<Value,IndexSpecifierList,Allocator>& m)noexcept; template< typename Tag,typename Value,typename IndexSpecifierList,typename Allocator > const typename index< multi_index_container<Value,IndexSpecifierList,Allocator>,Tag >::type& get(const multi_index_container<Value,IndexSpecifierList,Allocator>& m)noexcept; // multi_index_container global functions for projection of iterators: template< int N,typename IteratorType, typename Value,typename IndexSpecifierList,typename Allocator > typename nth_index< multi_index_container<Value,IndexSpecifierList,Allocator>,N >::type::iterator project( multi_index_container<Value,IndexSpecifierList,Allocator>& m, IteratorType it); template< int N,typename IteratorType, typename Value,typename IndexSpecifierList,typename Allocator > typename nth_index< multi_index_container<Value,IndexSpecifierList,Allocator>,N >::type::const_iterator project( const multi_index_container<Value,IndexSpecifierList,Allocator>& m, IteratorType it); template< typename Tag,typename IteratorType, typename Value,typename IndexSpecifierList,typename Allocator > typename index< multi_index_container<Value,IndexSpecifierList,Allocator>,Tag >::type::iterator project( multi_index_container<Value,IndexSpecifierList,Allocator>& m, IteratorType it); template< typename Tag,typename IteratorType, typename Value,typename IndexSpecifierList,typename Allocator > typename index< multi_index_container<Value,IndexSpecifierList,Allocator>,Tag >::type::const_iterator project( const multi_index_container<Value,IndexSpecifierList,Allocator>& m, IteratorType it); // comparison: // OP is any of ==,<,!=,>,>=,<= template< typename Value1,typename IndexSpecifierList1,typename Allocator1, typename Value2,typename IndexSpecifierList2,typename Allocator2 > bool operator OP( const multi_index_container<Value1,IndexSpecifierList1,Allocator1>& x, const multi_index_container<Value2,IndexSpecifierList2,Allocator2>& y); // specialized algorithms: template<typename Value,typename IndexSpecifierList,typename Allocator> void swap( multi_index_container<Value,IndexSpecifierList,Allocator>& x, multi_index_container<Value,IndexSpecifierList,Allocator>& y); } // namespace boost::multi_index using multi_index::multi_index_container; using multi_index::get; using multi_index::project; } // namespace boost </pre></blockquote> <h3><a name="multi_index_container"> Class template <code>multi_index_container</code> </a></h3> This is the main component of Boost.MultiIndex. A <code>multi_index_container</code> is a container class template holding a compile-time user-defined list of <a href="indices.html">indices</a>. These indices provide different interfaces for the management of the elements of the <code>multi_index_container</code>. By itself, <code>multi_index_container</code> only provides basic functionality for construction and for access to the indices held. A <code>multi_index_container</code> type is instantiated with the type of the elements contained and a non-empty <a href="../../../../libs/mpl/doc/refmanual/forward-sequence.html"> <code>MPL Forward Sequence</code></a> specifying which indices conform the class. For convenience of use, all public methods and types of the first index specified are inherited by <code>multi_index_container</code>. This also includes global operators and functions associated with the index (vg. comparison and <code>swap</code>.) <blockquote><pre> template< typename Value, typename IndexSpecifierList=indexed_by<ordered_unique<identity<Value> > >, typename Allocator=std::allocator<Value> > class multi_index_container { public: // types: typedef implementation defined ctor_args_list; typedef implementation defined index_specifier_type_list; typedef implementation defined index_type_list; typedef implementation defined iterator_type_list; typedef implementation defined const_iterator_type_list; typedef Allocator allocator_type; // nested class templates: template<int N> struct nth_index {typedef implementation defined type;}; template<typename Tag> struct index {typedef implementation defined type;}; template<int N> struct nth_index_iterator // deprecated {typedef implementation defined type;}; template<int N> struct nth_index_const_iterator // deprecated {typedef implementation defined type;}; template<typename Tag> struct index_iterator // deprecated {typedef implementation defined type;}; template<typename Tag> struct index_const_iterator // deprecated {typedef implementation defined type;}; // construct/copy/destroy: explicit multi_index_container( const ctor_args_list& args_list=ctor_args_list(), const allocator_type& al=allocator_type()); explicit multi_index_container(const allocator_type& al); template<typename InputIterator> multi_index_container( InputIterator first,InputIterator last, const ctor_args_list& args_list=ctor_args_list(), const allocator_type& al=allocator_type()); multi_index_container( std::initializer_list<Value> list, const ctor_args_list& args_list=ctor_args_list(), const allocator_type& al=allocator_type()); multi_index_container( const multi_index_container<Value,IndexSpecifierList,Allocator>& x); multi_index_container( multi_index_container<Value,IndexSpecifierList,Allocator>&& x); ~multi_index_container(); multi_index_container<Value,IndexSpecifierList,Allocator>& operator=( const multi_index_container<Value,IndexSpecifierList,Allocator>& x); multi_index_container<Value,IndexSpecifierList,Allocator>& operator=( multi_index_container<Value,IndexSpecifierList,Allocator>&& x); multi_index_container<Value,IndexSpecifierList,Allocator>& operator=( std::initializer_list<Value> list) allocator_type get_allocator()const noexcept; // retrieval of indices template<int N> typename nth_index<N>::type& get()noexcept; template<int N> const typename nth_index<N>::type& get()const noexcept; template<typename Tag> typename index<Tag>::type& get()noexcept; template<typename Tag> const typename index<Tag>::type& get()const noexcept; // projection of iterators template<int N,typename IteratorType> typename nth_index<N>::type::iterator project(IteratorType it); template<int N,typename IteratorType> typename nth_index<N>::type::const_iterator project(IteratorType it)const; template<typename Tag,typename IteratorType> typename index<Tag>::type::iterator project(IteratorType it); template<typename Tag,typename IteratorType> typename index<Tag>::type::const_iterator project(IteratorType it)const; }; // multi_index_container associated global class templates: template<typename MultiIndexContainer,int N> struct nth_index { typedef typename MultiIndexContainer::nth_index<N>::type type; }; template<typename MultiIndexContainer,typename Tag> struct index { typedef typename MultiIndexContainer::index<Tag>::type type; }; template<typename MultiIndexContainer,int N> struct nth_index_iterator // deprecated { typedef typename MultiIndexContainer::nth_index_iterator<N>::type type; }; template<typename MultiIndexContainer,int N> struct nth_index_const_iterator // deprecated { typedef typename MultiIndexContainer::nth_index_const_iterator<N>::type type; }; template<typename MultiIndexContainer,typename Tag> struct index_iterator // deprecated { typedef typename MultiIndexContainer::index_iterator<Tag>::type type; }; template<typename MultiIndexContainer,typename Tag> struct index_const_iterator // deprecated { typedef typename MultiIndexContainer::index_const_iterator<Tag>::type type; }; // multi_index_container global functions for index retrieval: template< int N,typename Value,typename IndexSpecifierList,typename Allocator > typename nth_index< multi_index_container<Value,IndexSpecifierList,Allocator>,N >::type& get(multi_index_container<Value,IndexSpecifierList,Allocator>& m)noexcept { return m.get<N>(); } template< int N,<sp