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 - Ordered indices reference</title> <link rel="stylesheet" href="../style.css" type="text/css"> <link rel="start" href="../index.html"> <link rel="prev" href="indices.html"> <link rel="up" href="index.html"> <link rel="next" href="hash_indices.html"> </head> <body> <h1><img src="../../../../boost.png" alt="boost.png (6897 bytes)" align= "middle" width="277" height="86">Boost.MultiIndex Ordered indices reference</h1> <div class="prev_link"><a href="indices.html"><img src="../prev.gif" alt="index reference" border="0"> Index 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="hash_indices.html"><img src="../next.gif" alt="hashed indices" border="0"> Hashed indices </a></div> <hr> <h2>Contents</h2> <ul> <li><a href="#ord_index_fwd_synopsis">Header <code>"boost/multi_index/ordered_index_fwd.hpp"</code> synopsis</a></li> <li><a href="#synopsis">Header <code>"boost/multi_index/ordered_index.hpp"</code> synopsis</a> <ul> <li><a href="#unique_non_unique"> Index specifiers <code>ordered_unique</code> and <code>ordered_non_unique</code> </a></li> <li><a href="#ord_indices">Ordered indices</a> <ul> <li><a href="#complexity_signature">Complexity signature</a></li> <li><a href="#instantiation_types">Instantiation types</a></li> <li><a href="#constructors">Constructors, copy and assignment</a></li> <li><a href="#iterators">Iterators</a></li> <li><a href="#modifiers">Modifiers</a></li> <li><a href="#observers">Observers</a></li> <li><a href="#set_operations">Set operations</a></li> <li><a href="#range_operations">Range operations</a></li> <li><a href="#serialization">Serialization</a></li> </ul> </li> </ul> </li> </ul> <h2> <a name="ord_index_fwd_synopsis">Header <a href="../../../../boost/multi_index/ordered_index_fwd.hpp"> <code>"boost/multi_index/ordered_index_fwd.hpp"</code></a> synopsis</a></h2> <blockquote><pre> namespace boost{ namespace multi_index{ // index specifiers ordered_unique and ordered_non_unique template<consult ordered_unique reference for arguments> struct ordered_unique; template<consult ordered_non_unique reference for arguments> struct ordered_non_unique; // indices namespace detail{ template<implementation defined> class index name is implementation defined; } // namespace boost::multi_index::detail } // namespace boost::multi_index } // namespace boost </pre></blockquote> <code>ordered_index_fwd.hpp</code> provides forward declarations for index specifiers <a href="#unique_non_unique"><code>ordered_unique</code> and <code>ordered_non_unique</code></a> and their associated <a href="#ord_indices">ordered index</a> classes. <h2> <a name="synopsis">Header <a href="../../../../boost/multi_index/ordered_index.hpp"> <code>"boost/multi_index/ordered_index.hpp"</code></a> synopsis</a></h2> <blockquote><pre> #include <initializer_list> namespace boost{ namespace multi_index{ // index specifiers ordered_unique and ordered_non_unique template<consult ordered_unique reference for arguments> struct ordered_unique; template<consult ordered_non_unique reference for arguments> struct ordered_non_unique; // indices namespace detail{ template<implementation defined> class index class name implementation defined; // index comparison: // OP is any of ==,<,!=,>,>=,<= template<arg set 1,arg set 2> bool operator OP( const index class name<arg set 1>& x,const index class name<arg set 2>& y); // index specialized algorithms: template<implementation defined> void swap(index class name& x,index class name& y); } // namespace boost::multi_index::detail } // namespace boost::multi_index } // namespace boost </pre></blockquote> <h3><a name="unique_non_unique"> Index specifiers <code>ordered_unique</code> and <code>ordered_non_unique</code> </a></h3> These <a href="indices.html#index_specification">index specifiers</a> allow for insertion of <a href="#ord_indices">ordered indices</a> without and with allowance of duplicate elements, respectively. The syntax of <code>ordered_unique</code> and <code>ordered_non_unique</code> coincide, thus we describe them in a grouped manner. <code>ordered_unique</code> and <code>ordered_non_unique</code> can be instantiated in two different forms, according to whether a tag list for the index is provided or not: <blockquote><pre> template< typename KeyFromValue, typename Compare=std::less<KeyFromValue::result_type> > struct (ordered_unique | ordered_non_unique); template< typename TagList, typename KeyFromValue, typename Compare=std::less<KeyFromValue::result_type> > struct (ordered_unique | ordered_non_unique); </pre></blockquote> If provided, <code>TagList</code> must be an instantiation of the class template <a href="indices.html#tag"><code>tag</code></a>. The template arguments are used by the corresponding index implementation, refer to the <a href="#ord_indices">ordered indices</a> reference section for further explanations on their acceptable type values. <h3><a name="ord_indices">Ordered indices</a></h3> An ordered index provides a set-like interface to the underlying heap of elements contained in a <code>multi_index_container</code>. An ordered index is particularized according to a given <a href="key_extraction.html#key_extractors"><code>Key Extractor</code></a> that retrieves keys from elements of <code>multi_index_container</code> and a comparison predicate. There are two variants of ordered indices: unique, which do not allow duplicate elements (with respect to its associated comparison predicate) and non-unique, which accept those duplicates. The interface of these two variants is the same, so they are documented together, with minor differences explicitly stated when they exist. Except where noted or if the corresponding interface does not exist, ordered indices (both unique and non-unique) satisfy the C++ requirements for associative containers at [associative.reqmts] (supporting unique and equivalent keys, respectively.) Accordingly, validity of iterators and references to elements is preserved. We only provide descriptions of those types and operations that do not exactly conform to or are not mandated by the standard requirements. <blockquote><pre> namespace boost{ namespace multi_index{ implementation defined unbounded; // see range() namespace detail{ template<implementation defined: dependent on types Value, Allocator, TagList, KeyFromValue, Compare> class name is implementation defined { public: // types: typedef typename KeyFromValue::result_type key_type; typedef Value value_type; typedef KeyFromValue key_from_value; typedef Compare key_compare; typedef implementation defined value_compare; typedef boost::tuple<key_from_value,key_compare> ctor_args; typedef TagList tag_list; typedef Allocator allocator_type; typedef typename Allocator::reference reference; typedef typename Allocator::const_reference const_reference; typedef implementation defined iterator; typedef implementation defined const_iterator; typedef implementation defined size_type; typedef implementation defined difference_type; typedef typename Allocator::pointer pointer; typedef typename Allocator::const_pointer const_pointer; typedef equivalent to std::reverse_iterator<iterator> reverse_iterator; typedef equivalent to std::reverse_iterator<const_iterator> const_reverse_iterator; // construct/copy/destroy: index class name& operator=(const index class name& x); index class name& operator=(std::initializer_list<value_type> list); allocator_type get_allocator()const noexcept; // iterators: iterator begin()noexcept; const_iterator begin()const noexcept; iterator end()noexcept; const_iterator end()const noexcept; reverse_iterator rbegin()noexcept; const_reverse_iterator rbegin()const noexcept; reverse_iterator rend()noexcept; const_reverse_iterator rend()const noexcept; const_iterator cbegin()const noexcept; const_iterator cend()const noexcept; const_reverse_iterator crbegin()const noexcept; const_reverse_iterator crend()const noexcept; iterator iterator_to(const value_type& x); const_iterator iterator_to(const value_type& x)const; // capacity: bool empty()const noexcept; size_type size()const noexcept; size_type max_size()const noexcept; // modifiers: template<typename... Args> std::pair<iterator,bool> emplace(Args&&... args); template <typename... Args> iterator emplace_hint(iterator position,Args&&... args); std::pair<iterator,bool> insert(const value_type& x); std::pair<iterator,bool> insert(value_type&& x); iterator insert(iterator position,const value_type& x); iterator insert(iterator position,value_type&& x); template<typename InputIterator> void insert(InputIterator first,InputIterator last); void insert(std::initializer_list<value_type> list); iterator erase(iterator position); size_type erase(const key_type& x); iterator erase(iterator first,iterator last); bool replace(iterator position,const value_type& x); bool replace(iterator position,value_type&& x); template<typename Modifier> bool modify(iterator position,Modifier mod); template<typename Modifier,typename Rollback> bool modify(iterator position,Modifier mod,Rollback back); template<typename Modifier> bool modify_key(iterator position,Modifier mod); template<typename Modifier,typename Rollback> bool modify_key(iterator position,Modifier mod,Rollback back); void swap(index class name& x); void clear()noexcept; // observers: key_from_value key_extractor()const; key_compare key_comp()const; value_compare value_comp()const; // set operations: template<typename CompatibleKey> iterator find(const CompatibleKey& x)const; template<typename CompatibleKey,typename CompatibleCompare> iterator find( const CompatibleKey& x,const CompatibleCompare& comp)const; template<typename CompatibleKey> size_type count(const CompatibleKey& x)const; template<typename CompatibleKey,typename CompatibleCompare> size_type count(const CompatibleKey& x,const CompatibleCompare& comp)const; template<typename CompatibleKey> iterator lower_bound(const CompatibleKey& x)const; template<typename CompatibleKey,typename CompatibleCompare> iterator lower_bound( const CompatibleKey& x,const CompatibleCompare& comp)const; template<typename CompatibleKey> iterator upper_bound(const CompatibleKey& x)const; template<typename CompatibleKey,typename CompatibleCompare> iterator upper_bound( const CompatibleKey& x,const CompatibleCompare& comp)const; template<typename CompatibleKey> std::pair<iterator,iterator> equal_range( const CompatibleKey& x)const; template<typename CompatibleKey,typename CompatibleCompare> std::pair<iterator,iterator> equal_range( const CompatibleKey& x,const CompatibleCompare& comp)const; // range: template<typename LowerBounder,typename UpperBounder> std::pair<iterator,iterator> range( LowerBounder lower,UpperBounder upper)const; }; // index comparison: template<arg set 1,arg set 2> bool operator==( const index class name<arg set 1>& x, const index class name<arg set 2>& y) { return x.size()==y.size()&&std::equal(x.begin(),x.end(),y.begin()); } template<arg set 1,arg set 2> bool operator<( const index class name<arg set 1>& x, const index class name<arg set 2>& y) { return std::lexicographical_compare(x.begin(),x.end(),y.begin(),y.end()); } template<arg set 1,arg set 2> bool operator!=( const index class name<arg set 1>& x, const index class name<arg set 2>& y) { return !(x==y); } template<arg set 1,arg set 2> bool operator>( const index class name<arg set 1>& x, const index class name<arg set 2>& y) { return y<x; } template<arg set 1,arg set 2> bool operator>=( const index class name<arg set 1>& x, const index class name<arg set 2>& y) { return !(x<y); } template<arg set 1,arg set 2> bool operator<=( const index class name<arg set 1>& x, const index class name<arg set 2>& y) { return !(x>y); } // index specialized algorithms: template<implementation defined> void swap(index class name& x,index class name& y); } // namespace boost::multi_index::detail } // namespace boost::multi_index } // namespace boost </pre></blockquote> <h4><a name="complexity_signature">Complexity signature</a></h4> Here and in the descriptions of operations of ordered indices, we adopt the scheme outlined in the <a href="indices.html#complexity_signature">complexity signature section</a>. The complexity signature of ordered indices is: <ul> <li>copying: <code>c(n)=n*log(n)</code>,</li> <li>insertion: <code>i(n)=log(n)</code>,</li> <li>hinted insertion: <code>h(n)=1</code> (constant) if the hint element is immediately after the point of insertion, <code>h(n)=log(n)</code> otherwise,</li> <li>deletion: <code>d(n)=1</code> (amortized constant),</li> <li>replacement: <code>r(n)=1</code> (constant) if the element position does not change, <code>r(n)=log(n)</code> otherwise,</li> <li>modifying: <code>m(n)=1</code> (constant) if the element position does not change, <code>m(n)=log(n)</code> otherwise.</li> </ul> <h4><a name="instantiation_types">Instantiation types</a></h4> Ordered indices are instantiated internally to <code>multi_index_container</code> and specified by means of <a href="indices.html#indexed_by"><code>indexed_by</code></a> with <a href="#unique_non_unique"> index specifiers <code>ordered_unique</code> and <code>ordered_non_unique</code></a>. Instantiations are dependent on the following types: <ul> <li><code>Value</code> from <code>multi_index_container</code>,</li> <li><code>Allocator</code> from <code>multi_index_container</code>,</li> <li><code>TagList</code> from the index specifier (if provided, otherwise <code>tag<></code> is assumed),</li> <li><code>KeyFromValue</code> from the index specifier,</li> <li><code>Compare</code> from the index specifier.</li> </ul> <code>TagList</code> must be an instantiation of <a href="indices.html#tag"><code>tag</code></a>. The type <code>KeyFromValue</code>, which determines the mechanism for extracting a key from <code>Value</code>, must be a model of <a href="key_extraction.html#key_extractors"> <code>Key Extractor</code></a> from <code>Value</code>. <code>Compare</code> is a <code>CopyConstructible</code> binary predicate inducing a strict weak order on elements of <code>KeyFromValue::result_type</code>. <h4><a name="constructors">Constructors, copy and assignment</a></h4> As explained in the <a href="indices.html#index_concepts">index concepts section</a>, indices do not have public constructors or destructors. Assignment, on the other hand, is provided. <code>index class name& operator=(const index class name& x);</code> <blockquote> Effects: <blockquote><pre> a=b; </pre></blockquote> where <code>a</code> and <code>b</code> are the <code>multi_index_container</code> objects to which <code>*this</code> and <code>x</code> belong, respectively. Returns: <code>*this</code>. </blockquote> <code>index class name& operator=(std::initializer_list<value_type> list);</code> <blockquote> Effects: <blockquote><pre> a=list; </pre></blockquote> where <code>a</code> is the <code>multi_index_container</code> object to which <code>*this</code> belongs. Returns: <code>*this</code>. </blockquote> <h4><a name="iterators">Iterators</a></h4> <code>iterator       iterator_to(const value_type& x); const_iterator iterator_to(const value_type& x)const;</code> <blockquote> Requires: <code>x</code> is a reference to an element of the container. Returns: An iterator to <code>x</code>. Complexity: Constant. Exception safety: <code>nothrow</code>. </blockquote> <h4><a name="modifiers">Modifiers</a></h4> <code>template<typename... Args> std::pair<iterator,bool> emplace(Args&&... args);</code> <blockquote> Requires: <code>value_type</code> is <code>EmplaceConstructible</code> into <code>multi_index_container</code> from <code>args</code>. Effects: Inserts a <code>value_type</code> object constructed with <code>std::forward<Args>(args)...</code> into the <code>multi_index_container</code> to which the index belongs if <ul> <li>the index is non-unique OR no other element exists with equivalent key,</li> <li>AND insertion is allowed by all other indices of the <code>multi_index_container</code>.</li> </ul> Returns: The return value is a pair <code>p</code>. <code>p.second</code> is <code>true</code> if and only if insertion took place. On successful insertion, <code>p.