rnd_indices.html 78 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0.1 Transitional//EN">
  2. <html>
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  5. <title>Boost.MultiIndex Documentation - Random access indices reference</title>
  6. <link rel="stylesheet" href="../style.css" type="text/css">
  7. <link rel="start" href="../index.html">
  8. <link rel="prev" href="seq_indices.html">
  9. <link rel="up" href="index.html">
  10. <link rel="next" href="key_extraction.html">
  11. </head>
  12. <body>
  13. <h1><img src="../../../../boost.png" alt="boost.png (6897 bytes)" align=
  14. "middle" width="277" height="86">Boost.MultiIndex Random access indices reference</h1>
  15. <div class="prev_link"><a href="seq_indices.html"><img src="../prev.gif" alt="sequenced indices" border="0"><br>
  16. Sequenced indices
  17. </a></div>
  18. <div class="up_link"><a href="index.html"><img src="../up.gif" alt="Boost.MultiIndex reference" border="0"><br>
  19. Boost.MultiIndex reference
  20. </a></div>
  21. <div class="next_link"><a href="key_extraction.html"><img src="../next.gif" alt="key extraction" border="0"><br>
  22. Key extraction
  23. </a></div><br clear="all" style="clear: all;">
  24. <hr>
  25. <h2>Contents</h2>
  26. <ul>
  27. <li><a href="#rnd_index_fwd_synopsis">Header
  28. <code>"boost/multi_index/random_access_index_fwd.hpp"</code> synopsis</a></li>
  29. <li><a href="#synopsis">Header
  30. <code>"boost/multi_index/random_access_index.hpp"</code> synopsis</a>
  31. <ul>
  32. <li><a href="#random_access"><code>random_access</code> index specifier</a></li>
  33. <li><a href="#rnd_indices">Random access indices</a>
  34. <ul>
  35. <li><a href="#complexity_signature">Complexity signature</a></li>
  36. <li><a href="#instantiation_types">Instantiation types</a></li>
  37. <li><a href="#constructors">Constructors, copy and assignment</a></li>
  38. <li><a href="#iterators">Iterators</a></li>
  39. <li><a href="#capacity">Capacity operations</a></li>
  40. <li><a href="#modifiers">Modifiers</a></li>
  41. <li><a href="#list_operations">List operations</a></li>
  42. <li><a href="#rearrange_operations">Rearrange operations</a></li>
  43. <li><a href="#serialization">Serialization</a></li>
  44. </ul>
  45. </li>
  46. </ul>
  47. </li>
  48. </ul>
  49. <h2>
  50. <a name="rnd_index_fwd_synopsis">Header
  51. <a href="../../../../boost/multi_index/random_access_index_fwd.hpp">
  52. <code>"boost/multi_index/random_access_index_fwd.hpp"</code></a> synopsis</a></h2>
  53. <blockquote><pre>
  54. <span class=keyword>namespace</span> <span class=identifier>boost</span><span class=special>{</span>
  55. <span class=keyword>namespace</span> <span class=identifier>multi_index</span><span class=special>{</span>
  56. <span class=comment>// random_access index specifier</span>
  57. <span class=keyword>template</span><span class=special>&lt;</span><span class=keyword>typename</span> <span class=identifier>TagList</span><span class=special>=</span><span class=identifier>tag</span><span class=special>&lt;&gt;</span> <span class=special>&gt;</span> <span class=keyword>struct</span> <span class=identifier>random_access</span><span class=special>;</span>
  58. <span class=comment>// indices</span>
  59. <span class=keyword>namespace</span> <span class=identifier>detail</span><span class=special>{</span>
  60. <span class=keyword>template</span><span class=special>&lt;</span><b>implementation defined</b><span class=special>&gt;</span> <span class=keyword>class</span> <b>index class name implementation defined</b><span class=special>;</span>
  61. <span class=special>}</span> <span class=comment>// namespace boost::multi_index::detail</span>
  62. <span class=special>}</span> <span class=comment>// namespace boost::multi_index</span>
  63. <span class=special>}</span> <span class=comment>// namespace boost</span>
  64. </pre></blockquote>
  65. <p>
  66. <code>random_access_index_fwd.hpp</code> provides forward declarations for the
  67. <a href="#random_access"><code>random_access</code></a> index specifier and
  68. its associated <a href="#rnd_indices">random access index</a> class.
  69. </p>
  70. <h2>
  71. <a name="synopsis">Header
  72. <a href="../../../../boost/multi_index/random_access_index.hpp">
  73. <code>"boost/multi_index/random_access_index.hpp"</code></a> synopsis</a></h2>
  74. <blockquote><pre>
  75. <span class=preprocessor>#include</span> <span class=special>&lt;</span><span class=identifier>initializer_list</span><span class=special>&gt;</span>
  76. <span class=keyword>namespace</span> <span class=identifier>boost</span><span class=special>{</span>
  77. <span class=keyword>namespace</span> <span class=identifier>multi_index</span><span class=special>{</span>
  78. <span class=comment>// random_access index specifier</span>
  79. <span class=keyword>template</span><span class=special>&lt;</span><span class=keyword>typename</span> <span class=identifier>TagList</span><span class=special>=</span><span class=identifier>tag</span><span class=special>&lt;&gt;</span> <span class=special>&gt;</span> <span class=keyword>struct</span> <span class=identifier>random_access</span><span class=special>;</span>
  80. <span class=comment>// indices</span>
  81. <span class=keyword>namespace</span> <span class=identifier>detail</span><span class=special>{</span>
  82. <span class=keyword>template</span><span class=special>&lt;</span><b>implementation defined</b><span class=special>&gt;</span> <span class=keyword>class</span> <b>index class name implementation defined</b><span class=special>;</span>
  83. <span class=comment>// index comparison:</span>
  84. <span class=comment>// <b>OP</b> is any of ==,&lt;,!=,&gt;,&gt;=,&lt;=</span>
  85. <span class=keyword>template</span><span class=special>&lt;</span><b>arg set 1</b><span class=special>,</span><b>arg set 2</b><span class=special>&gt;</span>
  86. <span class=keyword>bool</span> <span class=keyword>operator</span> <b><i>OP</i></b><span class=special>(</span>
  87. <span class=keyword>const</span> <b>index class name</b><span class=special>&lt;</span><b>arg set 1</b><span class=special>&gt;&amp;</span> <span class=identifier>x</span><span class=special>,</span><span class=keyword>const</span> <b>index class name</b><span class=special>&lt;</span><b>arg set 2</b><span class=special>&gt;&amp;</span> <span class=identifier>y</span><span class=special>);</span>
  88. <span class=comment>// index specialized algorithms:</span>
  89. <span class=keyword>template</span><span class=special>&lt;</span><b>implementation defined</b><span class=special>&gt;</span>
  90. <span class=keyword>void</span> <span class=identifier>swap</span><span class=special>(</span><b>index class name</b><span class=special>&amp;</span> <span class=identifier>x</span><span class=special>,</span><b>index class name</b><span class=special>&amp;</span> <span class=identifier>y</span><span class=special>);</span>
  91. <span class=special>}</span> <span class=comment>// namespace boost::multi_index::detail</span>
  92. <span class=special>}</span> <span class=comment>// namespace boost::multi_index</span>
  93. <span class=special>}</span> <span class=comment>// namespace boost</span>
  94. </pre></blockquote>
  95. <h3><a name="random_access">
  96. <code>random_access</code> index specifier
  97. </a></h3>
  98. <p>
  99. This index specifier allows for insertion of a <a href="#rnd_indices">random
  100. access index</a>.</p>
  101. <blockquote><pre>
  102. <span class=keyword>template</span><span class=special>&lt;</span><span class=keyword>typename</span> <span class=identifier>TagList</span><span class=special>=</span><span class=identifier>tag</span><span class=special>&lt;&gt;</span> <span class=special>&gt;</span> <span class=keyword>struct</span> <span class=identifier>random_access</span><span class=special>;</span>
  103. </pre></blockquote>
  104. <p>If provided, <code>TagList</code> must be an instantiation of
  105. <a href="indices.html#tag"><code>tag</code></a>.
  106. </p>
  107. <h3><a name="rnd_indices">Random access indices</a></h3>
  108. <p>
  109. Random access indices are free-order sequences with constant time
  110. positional access and random access iterators. Elements in a
  111. random access index are by default sorted according to their order of
  112. insertion: this means that new elements inserted through a different index
  113. of the <code>multi_index_container</code> are appended to the end of the
  114. random access index; additionally, facilities are provided
  115. for further rearrangement of the elements. The public interface of
  116. random access indices includes that of
  117. <a href="seq_indices.html">sequenced indices</a>, with differences in
  118. the complexity of the operations, plus extra operations for
  119. positional access (<code>operator[]</code> and <code>at()</code>) and
  120. for capacity handling. Validity of iterators and references to elements
  121. is preserved in all operations, regardless of the capacity status.
  122. </p>
  123. <p>
  124. Except where noted or if the corresponding interface does not exist, random access
  125. indices verify the same container requirements as <code>std::vector</code>
  126. plus the requirements for <code>std::list</code> specific list operations at
  127. <b>[list.ops]</b>. Some of the most important differences with respect to
  128. <code>std::vector</code> are:
  129. <ul>
  130. <li>Random access indices do not provide memory contiguity, and hence do not
  131. have <code>data</code> member functions.
  132. </li>
  133. <li>The complexity of some operations, notably insertion and deletion, differ
  134. from those of <code>std::vector</code>.
  135. </li>
  136. <li>Unlike as in <code>std::vector</code>, insertions into a random access index
  137. may fail due to clashings with other indices. This alters the semantics
  138. of the operations provided with respect to their analogues in
  139. <code>std::vector</code>.
  140. </li>
  141. <li>Elements in a randon access index are not mutable, and can only be changed
  142. by means of <a href="#replace"><code>replace</code></a> and
  143. <a href="#modify"><code>modify</code></a> member functions.
  144. </li>
  145. <li><code>push_front</code> and <code>pop_front</code> are provided for
  146. compatibility with sequenced indices, even though they take linear time to execute.
  147. </li></ul>
  148. </p>
  149. <blockquote><pre>
  150. <span class=keyword>namespace</span> <span class=identifier>boost</span><span class=special>{</span>
  151. <span class=keyword>namespace</span> <span class=identifier>multi_index</span><span class=special>{</span>
  152. <span class=keyword>namespace</span> <span class=identifier>detail</span><span class=special>{</span>
  153. <span class=keyword>template</span><span class=special>&lt;</span><b>implementation defined: dependent on types Value, Allocator, TagList</b><span class=special>&gt;</span>
  154. <span class=keyword>class</span> <b>name is implementation defined</b>
  155. <span class=special>{</span>
  156. <span class=keyword>public</span><span class=special>:</span>
  157. <span class=comment>// types:</span>
  158. <span class=keyword>typedef</span> <span class=identifier>Value</span> <span class=identifier>value_type</span><span class=special>;</span>
  159. <span class=keyword>typedef</span> <span class=identifier>boost</span><span class=special>::</span><span class=identifier>tuples</span><span class=special>::</span><span class=identifier>null_type</span> <span class=identifier>ctor_args</span><span class=special>;</span>
  160. <span class=keyword>typedef</span> <span class=identifier>TagList</span> <span class=identifier>tag_list</span><span class=special>;</span>
  161. <span class=keyword>typedef</span> <span class=identifier>Allocator</span> <span class=identifier>allocator_type</span><span class=special>;</span>
  162. <span class=keyword>typedef</span> <span class=keyword>typename</span> <span class=identifier>allocator_type</span><span class=special>::</span><span class=identifier>reference</span> <span class=identifier>reference</span><span class=special>;</span>
  163. <span class=keyword>typedef</span> <span class=keyword>typename</span> <span class=identifier>allocator_type</span><span class=special>::</span><span class=identifier>const_reference</span> <span class=identifier>const_reference</span><span class=special>;</span>
  164. <span class=keyword>typedef</span> <b>implementation defined</b> <span class=identifier>iterator</span><span class=special>;</span>
  165. <span class=keyword>typedef</span> <b>implementation defined</b> <span class=identifier>const_iterator</span><span class=special>;</span>
  166. <span class=keyword>typedef</span> <b>implementation defined</b> <span class=identifier>size_type</span><span class=special>;</span>
  167. <span class=keyword>typedef</span> <b>implementation defined</b> <span class=identifier>difference_type</span><span class=special>;</span>
  168. <span class=keyword>typedef</span> <span class=keyword>typename</span> <span class=identifier>allocator_type</span><span class=special>::</span><span class=identifier>pointer</span> <span class=identifier>pointer</span><span class=special>;</span>
  169. <span class=keyword>typedef</span> <span class=keyword>typename</span> <span class=identifier>allocator_type</span><span class=special>::</span><span class=identifier>const_pointer</span> <span class=identifier>const_pointer</span><span class=special>;</span>
  170. <span class=keyword>typedef</span> <b>equivalent to
  171. std::reverse_iterator&lt;iterator&gt;</b> <span class=identifier>reverse_iterator</span><span class=special>;</span>
  172. <span class=keyword>typedef</span> <b>equivalent to
  173. std::reverse_iterator&lt;const_iterator&gt;</b> <span class=identifier>const_reverse_iterator</span><span class=special>;</span>
  174. <span class=comment>// construct/copy/destroy:</span>
  175. <b>index class name</b><span class=special>&amp;</span> <span class=keyword>operator</span><span class=special>=(</span><span class=keyword>const</span> <b>index class name</b><span class=special>&amp;</span> <span class=identifier>x</span><span class=special>);</span>
  176. <b>index class name</b><span class=special>&amp;</span> <span class=keyword>operator</span><span class=special>=(</span><span class=identifier>std</span><span class=special>::</span><span class=identifier>initializer_list</span><span class=special>&lt;</span><span class=identifier>value_type</span><span class=special>&gt;</span> <span class=identifier>list</span><span class=special>);</span>
  177. <span class=keyword>template</span> <span class=special>&lt;</span><span class=keyword>class</span> <span class=identifier>InputIterator</span><span class=special>&gt;</span>
  178. <span class=keyword>void</span> <span class=identifier>assign</span><span class=special>(</span><span class=identifier>InputIterator</span> <span class=identifier>first</span><span class=special>,</span><span class=identifier>InputIterator</span> <span class=identifier>last</span><span class=special>);</span>
  179. <span class=keyword>void</span> <span class=identifier>assign</span><span class=special>(</span><span class=identifier>std</span><span class=special>::</span><span class=identifier>initializer_list</span><span class=special>&lt;</span><span class=identifier>value_type</span><span class=special>&gt;</span> <span class=identifier>list</span><span class=special>)</span>
  180. <span class=keyword>void</span> <span class=identifier>assign</span><span class=special>(</span><span class=identifier>size_type</span> <span class=identifier>n</span><span class=special>,</span><span class=keyword>const</span> <span class=identifier>value_type</span><span class=special>&amp;</span> <span class=identifier>value</span><span class=special>);</span>
  181. <span class=identifier>allocator_type</span> <span class=identifier>get_allocator</span><span class=special>()</span><span class=keyword>const</span> <span class=keyword>noexcept</span><span class=special>;</span>
  182. <span class=comment>// iterators:</span>
  183. <span class=identifier>iterator</span> <span class=identifier>begin</span><span class=special>()</span><span class=keyword>noexcept</span><span class=special>;</span>
  184. <span class=identifier>const_iterator</span> <span class=identifier>begin</span><span class=special>()</span><span class=keyword>const</span> <span class=keyword>noexcept</span><span class=special>;</span>
  185. <span class=identifier>iterator</span> <span class=identifier>end</span><span class=special>()</span><span class=keyword>noexcept</span><span class=special>;</span>
  186. <span class=identifier>const_iterator</span> <span class=identifier>end</span><span class=special>()</span><span class=keyword>const</span> <span class=keyword>noexcept</span><span class=special>;</span>
  187. <span class=identifier>reverse_iterator</span> <span class=identifier>rbegin</span><span class=special>()</span><span class=keyword>noexcept</span><span class=special>;</span>
  188. <span class=identifier>const_reverse_iterator</span> <span class=identifier>rbegin</span><span class=special>()</span><span class=keyword>const</span> <span class=keyword>noexcept</span><span class=special>;</span>
  189. <span class=identifier>reverse_iterator</span> <span class=identifier>rend</span><span class=special>()</span><span class=keyword>noexcept</span><span class=special>;</span>
  190. <span class=identifier>const_reverse_iterator</span> <span class=identifier>rend</span><span class=special>()</span><span class=keyword>const</span> <span class=keyword>noexcept</span><span class=special>;</span>
  191. <span class=identifier>const_iterator</span> <span class=identifier>cbegin</span><span class=special>()</span><span class=keyword>const</span> <span class=keyword>noexcept</span><span class=special>;</span>
  192. <span class=identifier>const_iterator</span> <span class=identifier>cend</span><span class=special>()</span><span class=keyword>const</span> <span class=keyword>noexcept</span><span class=special>;</span>
  193. <span class=identifier>const_reverse_iterator</span> <span class=identifier>crbegin</span><span class=special>()</span><span class=keyword>const</span> <span class=keyword>noexcept</span><span class=special>;</span>
  194. <span class=identifier>const_reverse_iterator</span> <span class=identifier>crend</span><span class=special>()</span><span class=keyword>const</span> <span class=keyword>noexcept</span><span class=special>;</span>
  195. <span class=identifier>iterator</span> <span class=identifier>iterator_to</span><span class=special>(</span><span class=keyword>const</span> <span class=identifier>value_type</span><span class=special>&amp;</span> <span class=identifier>x</span><span class=special>);</span>
  196. <span class=identifier>const_iterator</span> <span class=identifier>iterator_to</span><span class=special>(</span><span class=keyword>const</span> <span class=identifier>value_type</span><span class=special>&amp;</span> <span class=identifier>x</span><span class=special>)</span><span class=keyword>const</span><span class=special>;</span>
  197. <span class=comment>// capacity:</span>
  198. <span class=keyword>bool</span> <span class=identifier>empty</span><span class=special>()</span><span class=keyword>const</span> <span class=keyword>noexcept</span><span class=special>;</span>
  199. <span class=identifier>size_type</span> <span class=identifier>size</span><span class=special>()</span><span class=keyword>const</span> <span class=keyword>noexcept</span><span class=special>;</span>
  200. <span class=identifier>size_type</span> <span class=identifier>max_size</span><span class=special>()</span><span class=keyword>const</span> <span class=keyword>noexcept</span><span class=special>;</span>
  201. <span class=identifier>size_type</span> <span class=identifier>capacity</span><span class=special>()</span><span class=keyword>const</span> <span class=keyword>noexcept</span><span class=special>;</span>
  202. <span class=keyword>void</span> <span class=identifier>reserve</span><span class=special>(</span><span class=identifier>size_type</span> <span class=identifier>m</span><span class=special>);</span>
  203. <span class=keyword>void</span> <span class=identifier>shrink_to_fit</span><span class=special>();</span>
  204. <span class=keyword>void</span> <span class=identifier>resize</span><span class=special>(</span><span class=identifier>size_type</span> <span class=identifier>n</span><span class=special>);</span>
  205. <span class=keyword>void</span> <span class=identifier>resize</span><span class=special>(</span><span class=identifier>size_type</span> <span class=identifier>n</span><span class=special>,</span><span class=keyword>const</span> <span class=identifier>value_type</span><span class=special>&amp;</span> <span class=identifier>x</span><span class=special>);</span>
  206. <span class=comment>// access:</span>
  207. <span class=identifier>const_reference</span> <span class=keyword>operator</span><span class=special>[](</span><span class=identifier>size_type</span> <span class=identifier>n</span><span class=special>)</span><span class=keyword>const</span><span class=special>;</span>
  208. <span class=identifier>const_reference</span> <span class=identifier>at</span><span class=special>(</span><span class=identifier>size_type</span> <span class=identifier>n</span><span class=special>)</span><span class=keyword>const</span><span class=special>;</span>
  209. <span class=identifier>const_reference</span> <span class=identifier>front</span><span class=special>()</span><span class=keyword>const</span><span class=special>;</span>
  210. <span class=identifier>const_reference</span> <span class=identifier>back</span><span class=special>()</span><span class=keyword>const</span><span class=special>;</span>
  211. <span class=comment>// modifiers:</span>
  212. <span class=keyword>template</span><span class=special>&lt;</span><span class=keyword>typename</span><span class=special>...</span> <span class=identifier>Args</span><span class=special>&gt;</span>
  213. <span class=identifier>std</span><span class=special>::</span><span class=identifier>pair</span><span class=special>&lt;</span><span class=identifier>iterator</span><span class=special>,</span><span class=keyword>bool</span><span class=special>&gt;</span> <span class=identifier>emplace_front</span><span class=special>(</span><span class=identifier>Args</span><span class=special>&amp;&amp;...</span> <span class=identifier>args</span><span class=special>);</span>
  214. <span class=identifier>std</span><span class=special>::</span><span class=identifier>pair</span><span class=special>&lt;</span><span class=identifier>iterator</span><span class=special>,</span><span class=keyword>bool</span><span class=special>&gt;</span> <span class=identifier>push_front</span><span class=special>(</span><span class=keyword>const</span> <span class=identifier>value_type</span><span class=special>&amp;</span> <span class=identifier>x</span><span class=special>);</span>
  215. <span class=identifier>std</span><span class=special>::</span><span class=identifier>pair</span><span class=special>&lt;</span><span class=identifier>iterator</span><span class=special>,</span><span class=keyword>bool</span><span class=special>&gt;</span> <span class=identifier>push_front</span><span class=special>(</span><span class=identifier>value_type</span><span class=special>&amp;&amp;</span> <span class=identifier>x</span><span class=special>);</span>
  216. <span class=keyword>void</span> <span class=identifier>pop_front</span><span class=special>();</span>
  217. <span class=keyword>template</span><span class=special>&lt;</span><span class=keyword>typename</span><span class=special>...</span> <span class=identifier>Args</span><span class=special>&gt;</span>
  218. <span class=identifier>std</span><span class=special>::</span><span class=identifier>pair</span><span class=special>&lt;</span><span class=identifier>iterator</span><span class=special>,</span><span class=keyword>bool</span><span class=special>&gt;</span> <span class=identifier>emplace_back</span><span class=special>(</span><span class=identifier>Args</span><span class=special>&amp;&amp;...</span> <span class=identifier>args</span><span class=special>);</span>
  219. <span class=identifier>std</span><span class=special>::</span><span class=identifier>pair</span><span class=special>&lt;</span><span class=identifier>iterator</span><span class=special>,</span><span class=keyword>bool</span><span class=special>&gt;</span> <span class=identifier>push_back</span><span class=special>(</span><span class=keyword>const</span> <span class=identifier>value_type</span><span class=special>&amp;</span> <span class=identifier>x</span><span class=special>);</span>
  220. <span class=identifier>std</span><span class=special>::</span><span class=identifier>pair</span><span class=special>&lt;</span><span class=identifier>iterator</span><span class=special>,</span><span class=keyword>bool</span><span class=special>&gt;</span> <span class=identifier>push_back</span><span class=special>(</span><span class=identifier>value_type</span><span class=special>&amp;&amp;</span> <span class=identifier>x</span><span class=special>);</span>
  221. <span class=keyword>void</span> <span class=identifier>pop_back</span><span class=special>();</span>
  222. <span class=keyword>template</span><span class=special>&lt;</span><span class=keyword>typename</span><span class=special>...</span> <span class=identifier>Args</span><span class=special>&gt;</span>
  223. <span class=identifier>std</span><span class=special>::</span><span class=identifier>pair</span><span class=special>&lt;</span><span class=identifier>iterator</span><span class=special>,</span><span class=keyword>bool</span><span class=special>&gt;</span> <span class=identifier>emplace</span><span class=special>(</span><span class=identifier>iterator</span> <span class=identifier>position</span><span class=special>,</span><span class=identifier>Args</span><span class=special>&amp;&amp;...</span> <span class=identifier>args</span><span class=special>);</span>
  224. <span class=identifier>std</span><span class=special>::</span><span class=identifier>pair</span><span class=special>&lt;</span><span class=identifier>iterator</span><span class=special>,</span><span class=keyword>bool</span><span class=special>&gt;</span> <span class=identifier>insert</span><span class=special>(</span><span class=identifier>iterator</span> <span class=identifier>position</span><span class=special>,</span><span class=keyword>const</span> <span class=identifier>value_type</span><span class=special>&amp;</span> <span class=identifier>x</span><span class=special>);</span>
  225. <span class=identifier>std</span><span class=special>::</span><span class=identifier>pair</span><span class=special>&lt;</span><span class=identifier>iterator</span><span class=special>,</span><span class=keyword>bool</span><span class=special>&gt;</span> <span class=identifier>insert</span><span class=special>(</span><span class=identifier>iterator</span> <span class=identifier>position</span><span class=special>,</span><span class=identifier>value_type</span><span class=special>&amp;&amp;</span> <span class=identifier>x</span><span class=special>);</span>
  226. <span class=keyword>void</span> <span class=identifier>insert</span><span class=special>(</span><span class=identifier>iterator</span> <span class=identifier>position</span><span class=special>,</span><span class=identifier>size_type</span> <span class=identifier>m</span><span class=special>,</span><span class=keyword>const</span> <span class=identifier>value_type</span><span class=special>&amp;</span> <span class=identifier>x</span><span class=special>);</span>
  227. <span class=keyword>template</span><span class=special>&lt;</span><span class=keyword>typename</span> <span class=identifier>InputIterator</span><span class=special>&gt;</span>
  228. <span class=keyword>void</span> <span class=identifier>insert</span><span class=special>(</span><span class=identifier>iterator</span> <span class=identifier>position</span><span class=special>,</span><span class=identifier>InputIterator</span> <span class=identifier>first</span><span class=special>,</span><span class=identifier>InputIterator</span> <span class=identifier>last</span><span class=special>);</span>
  229. <span class=keyword>void</span> <span class=identifier>insert</span><span class=special>(</span><span class=identifier>iterator</span> <span class=identifier>position</span><span class=special>,</span><span class=identifier>std</span><span class=special>::</span><span class=identifier>initializer_list</span><span class=special>&lt;</span><span class=identifier>value_type</span><span class=special>&gt;</span> <span class=identifier>list</span><span class=special>);</span>
  230. <span class=identifier>iterator</span> <span class=identifier>erase</span><span class=special>(</span><span class=identifier>iterator</span> <span class=identifier>position</span><span class=special>);</span>
  231. <span class=identifier>iterator</span> <span class=identifier>erase</span><span class=special>(</span><span class=identifier>iterator</span> <span class=identifier>first</span><span class=special>,</span><span class=identifier>iterator</span> <span class=identifier>last</span><span class=special>);</span>
  232. <span class=keyword>bool</span> <span class=identifier>replace</span><span class=special>(</span><span class=identifier>iterator</span> <span class=identifier>position</span><span class=special>,</span><span class=keyword>const</span> <span class=identifier>value_type</span><span class=special>&amp;</span> <span class=identifier>x</span><span class=special>);</span>
  233. <span class=keyword>bool</span> <span class=identifier>replace</span><span class=special>(</span><span class=identifier>iterator</span> <span class=identifier>position</span><span class=special>,</span><span class=identifier>value_type</span><span class=special>&amp;&amp;</span> <span class=identifier>x</span><span class=special>);</span>
  234. <span class=keyword>template</span><span class=special>&lt;</span><span class=keyword>typename</span> <span class=identifier>Modifier</span><span class=special>&gt;</span> <span class=keyword>bool</span> <span class=identifier>modify</span><span class=special>(</span><span class=identifier>iterator</span> <span class=identifier>position</span><span class=special>,</span><span class=identifier>Modifier</span> <span class=identifier>mod</span><span class=special>);</span>
  235. <span class=keyword>template</span><span class=special>&lt;</span><span class=keyword>typename</span> <span class=identifier>Modifier</span><span class=special>,</span><span class=keyword>typename</span> <span class=identifier>Rollback</span><span class=special>&gt;</span>
  236. <span class=keyword>bool</span> <span class=identifier>modify</span><span class=special>(</span><span class=identifier>iterator</span> <span class=identifier>position</span><span class=special>,</span><span class=identifier>Modifier</span> <span class=identifier>mod</span><span class=special>,</span><span class=identifier>Rollback</span> <span class=identifier>back</span><span class=special>);</span>
  237. <span class=keyword>void</span> <span class=identifier>swap</span><span class=special>(</span><b>index class name</b><span class=special>&amp;</span> <span class=identifier>x</span><span class=special>);</span>
  238. <span class=keyword>void</span> <span class=identifier>clear</span><span class=special>()</span><span class=keyword>noexcept</span><span class=special>;</span>
  239. <span class=comment>// list operations:</span>
  240. <span class=keyword>void</span> <span class=identifier>splice</span><span class=special>(</span><span class=identifier>iterator</span> <span class=identifier>position</span><span class=special>,</span><b>index class name</b><span class=special>&amp;</span> <span class=identifier>x</span><span class=special>);</span>
  241. <span class=keyword>void</span> <span class=identifier>splice</span><span class=special>(</span><span class=identifier>iterator</span> <span class=identifier>position</span><span class=special>,</span><b>index class name</b><span class=special>&amp;</span> <span class=identifier>x</span><span class=special>,</span><span class=identifier>iterator</span> <span class=identifier>i</span><span class=special>);</span>
  242. <span class=keyword>void</span> <span class=identifier>splice</span><span class=special>(</span>
  243. <span class=identifier>iterator</span> <span class=identifier>position</span><span class=special>,</span><b>index class name</b><span class=special>&amp;</span> <span class=identifier>x</span><span class=special>,</span><span class=identifier>iterator</span> <span class=identifier>first</span><span class=special>,</span><span class=identifier>iterator</span> <span class=identifier>last</span><span class=special>);</span>
  244. <span class=keyword>void</span> <span class=identifier>remove</span><span class=special>(</span><span class=keyword>const</span> <span class=identifier>value_type</span><span class=special>&amp;</span> <span class=identifier>value</span><span class=special>);</span>
  245. <span class=keyword>template</span><span class=special>&lt;</span><span class=keyword>typename</span> <span class=identifier>Predicate</span><span class=special>&gt;</span> <span class=keyword>void</span> <span class=identifier>remove_if</span><span class=special>(</span><span class=identifier>Predicate</span> <span class=identifier>pred</span><span class=special>);</span>
  246. <span class=keyword>void</span> <span class=identifier>unique</span><span class=special>();</span>
  247. <span class=keyword>template</span> <span class=special>&lt;</span><span class=keyword>class</span> <span class=identifier>BinaryPredicate</span><span class=special>&gt;</span>
  248. <span class=keyword>void</span> <span class=identifier>unique</span><span class=special>(</span><span class=identifier>BinaryPredicate</span> <span class=identifier>binary_pred</span><span class=special>);</span>
  249. <span class=keyword>void</span> <span class=identifier>merge</span><span class=special>(</span><b>index class name</b><span class=special>&amp;</span> <span class=identifier>x</span><span class=special>);</span>
  250. <span class=keyword>template</span> <span class=special>&lt;</span><span class=keyword>typename</span> <span class=identifier>Compare</span><span class=special>&gt;</span> <span class=keyword>void</span> <span class=identifier>merge</span><span class=special>(</span><b>index class name</b><span class=special>&amp;</span> <span class=identifier>x</span><span class=special>,</span><span class=identifier>Compare</span> <span class=identifier>comp</span><span class=special>);</span>
  251. <span class=keyword>void</span> <span class=identifier>sort</span><span class=special>();</span>
  252. <span class=keyword>template</span> <span class=special>&lt;</span><span class=keyword>typename</span> <span class=identifier>Compare</span><span class=special>&gt;</span> <span class=keyword>void</span> <span class=identifier>sort</span><span class=special>(</span><span class=identifier>Compare</span> <span class=identifier>comp</span><span class=special>);</span>
  253. <span class=keyword>void</span> <span class=identifier>reverse</span><span class=special>()</span><span class=keyword>noexcept</span><span class=special>;</span>
  254. <span class=comment>// rearrange operations:</span>
  255. <span class=keyword>void</span> <span class=identifier>relocate</span><span class=special>(</span><span class=identifier>iterator</span> <span class=identifier>position</span><span class=special>,</span><span class=identifier>iterator</span> <span class=identifier>i</span><span class=special>);</span>
  256. <span class=keyword>void</span> <span class=identifier>relocate</span><span class=special>(</span><span class=identifier>iterator</span> <span class=identifier>position</span><span class=special>,</span><span class=identifier>iterator</span> <span class=identifier>first</span><span class=special>,</span><span class=identifier>iterator</span> <span class=identifier>last</span><span class=special>);</span>
  257. <span class=keyword>template</span><span class=special>&lt;</span><span class=keyword>typename</span> <span class=identifier>InputIterator</span><span class=special>&gt;</span> <span class=keyword>void</span> <span class=identifier>rearrange</span><span class=special>(</span><span class=identifier>InputIterator</span> <span class=identifier>first</span><span class=special>);</span>
  258. <span class=special>}</span>
  259. <span class=comment>// index comparison:</span>
  260. <span class=keyword>template</span><span class=special>&lt;</span><b>arg set 1</b><span class=special>,</span><b>arg set 2</b><span class=special>&gt;</span>
  261. <span class=keyword>bool</span> <span class=keyword>operator</span><span class=special>==(</span>
  262. <span class=keyword>const</span> <b>index class name</b><span class=special>&lt;</span><b>arg set 1</b><span class=special>&gt;&amp;</span> <span class=identifier>x</span><span class=special>,</span>
  263. <span class=keyword>const</span> <b>index class name</b><span class=special>&lt;</span><b>arg set 2</b><span class=special>&gt;&amp;</span> <span class=identifier>y</span><span class=special>)</span>
  264. <span class=special>{</span>
  265. <span class=keyword>return</span> <span class=identifier>x</span><span class=special>.</span><span class=identifier>size</span><span class=special>()==</span><span class=identifier>y</span><span class=special>.</span><span class=identifier>size</span><span class=special>()&amp;&amp;</span><span class=identifier>std</span><span class=special>::</span><span class=identifier>equal</span><span class=special>(</span><span class=identifier>x</span><span class=special>.</span><span class=identifier>begin</span><span class=special>(),</span><span class=identifier>x</span><span class=special>.</span><span class=identifier>end</span><span class=special>(),</span><span class=identifier>y</span><span class=special>.</span><span class=identifier>begin</span><span class=special>());</span>
  266. <span class=special>}</span>
  267. <span class=keyword>template</span><span class=special>&lt;</span><b>arg set 1</b><span class=special>,</span><b>arg set 2</b><span class=special>&gt;</span>
  268. <span class=keyword>bool</span> <span class=keyword>operator</span><span class=special>&lt;(</span>
  269. <span class=keyword>const</span> <b>index class name</b><span class=special>&lt;</span><b>arg set 1</b><span class=special>&gt;&amp;</span> <span class=identifier>x</span><span class=special>,</span>
  270. <span class=keyword>const</span> <b>index class name</b><span class=special>&lt;</span><b>arg set 2</b><span class=special>&gt;&amp;</span> <span class=identifier>y</span><span class=special>)</span>
  271. <span class=special>{</span>
  272. <span class=keyword>return</span> <span class=identifier>std</span><span class=special>::</span><span class=identifier>lexicographical_compare</span><span class=special>(</span><span class=identifier>x</span><span class=special>.</span><span class=identifier>begin</span><span class=special>(),</span><span class=identifier>x</span><span class=special>.</span><span class=identifier>end</span><span class=special>(),</span><span class=identifier>y</span><span class=special>.</span><span class=identifier>begin</span><span class=special>(),</span><span class=identifier>y</span><span class=special>.</span><span class=identifier>end</span><span class=special>());</span>
  273. <span class=special>}</span>
  274. <span class=keyword>template</span><span class=special>&lt;</span><b>arg set 1</b><span class=special>,</span><b>arg set 2</b><span class=special>&gt;</span>
  275. <span class=keyword>bool</span> <span class=keyword>operator</span><span class=special>!=(</span>
  276. <span class=keyword>const</span> <b>index class name</b><span class=special>&lt;</span><b>arg set 1</b><span class=special>&gt;&amp;</span> <span class=identifier>x</span><span class=special>,</span>
  277. <span class=keyword>const</span> <b>index class name</b><span class=special>&lt;</span><b>arg set 2</b><span class=special>&gt;&amp;</span> <span class=identifier>y</span><span class=special>)</span>
  278. <span class=special>{</span>
  279. <span class=keyword>return</span> <span class=special>!(</span><span class=identifier>x</span><span class=special>==</span><span class=identifier>y</span><span class=special>);</span>
  280. <span class=special>}</span>
  281. <span class=keyword>template</span><span class=special>&lt;</span><b>arg set 1</b><span class=special>,</span><b>arg set 2</b><span class=special>&gt;</span>
  282. <span class=keyword>bool</span> <span class=keyword>operator</span><span class=special>&gt;(</span>
  283. <span class=keyword>const</span> <b>index class name</b><span class=special>&lt;</span><b>arg set 1</b><span class=special>&gt;&amp;</span> <span class=identifier>x</span>
  284. <span class=special>,</span><span class=keyword>const</span> <b>index class name</b><span class=special>&lt;</span><b>arg set 2</b><span class=special>&gt;&amp;</span> <span class=identifier>y</span><span class=special>)</span>
  285. <span class=special>{</span>
  286. <span class=keyword>return</span> <span class=identifier>y</span><span class=special>&lt;</span><span class=identifier>x</span><span class=special>;</span>
  287. <span class=special>}</span>
  288. <span class=keyword>template</span><span class=special>&lt;</span><b>arg set 1</b><span class=special>,</span><b>arg set 2</b><span class=special>&gt;</span>
  289. <span class=keyword>bool</span> <span class=keyword>operator</span><span class=special>&gt;=(</span>
  290. <span class=keyword>const</span> <b>index class name</b><span class=special>&lt;</span><b>arg set 1</b><span class=special>&gt;&amp;</span> <span class=identifier>x</span><span class=special>,</span>
  291. <span class=keyword>const</span> <b>index class name</b><span class=special>&lt;</span><b>arg set 2</b><span class=special>&gt;&amp;</span> <span class=identifier>y</span><span class=special>)</span>
  292. <span class=special>{</span>
  293. <span class=keyword>return</span> <span class=special>!(</span><span class=identifier>x</span><span class=special>&lt;</span><span class=identifier>y</span><span class=special>);</span>
  294. <span class=special>}</span>
  295. <span class=keyword>template</span><span class=special>&lt;</span><b>arg set 1</b><span class=special>,</span><b>arg set 2</b><span class=special>&gt;</span>
  296. <span class=keyword>bool</span> <span class=keyword>operator</span><span class=special>&lt;=(</span>
  297. <span class=keyword>const</span> <b>index class name</b><span class=special>&lt;</span><b>arg set 1</b><span class=special>&gt;&amp;</span> <span class=identifier>x</span><span class=special>,</span>
  298. <span class=keyword>const</span> <b>index class name</b><span class=special>&lt;</span><b>arg set 2</b><span class=special>&gt;&amp;</span> <span class=identifier>y</span><span class=special>)</span>
  299. <span class=special>{</span>
  300. <span class=keyword>return</span> <span class=special>!(</span><span class=identifier>x</span><span class=special>&gt;</span><span class=identifier>y</span><span class=special>);</span>
  301. <span class=special>}</span>
  302. <span class=comment>// index specialized algorithms:</span>
  303. <span class=keyword>template</span><span class=special>&lt;</span><b>implementation defined</b><span class=special>&gt;</span>
  304. <span class=keyword>void</span> <span class=identifier>swap</span><span class=special>(</span><b>index class name</b><span class=special>&amp;</span> <span class=identifier>x</span><span class=special>,</span><b>index class name</b><span class=special>&amp;</span> <span class=identifier>y</span><span class=special>);</span>
  305. <span class=special>}</span> <span class=comment>// namespace boost::multi_index::detail</span>
  306. <span class=special>}</span> <span class=comment>// namespace boost::multi_index</span>
  307. <span class=special>}</span> <span class=comment>// namespace boost</span>
  308. </pre></blockquote>
  309. <h4><a name="complexity_signature">Complexity signature</a></h4>
  310. <p>
  311. Here and in the descriptions of operations of random access indices, we
  312. adopt the scheme outlined in the
  313. <a href="indices.html#complexity_signature">complexity signature
  314. section</a>. The complexity signature of random access indices is:
  315. <ul>
  316. <li>copying: <code>c(n)=n*log(n)</code>,</li>
  317. <li>insertion: <code>i(n)=1</code> (amortized constant),</li>
  318. <li>hinted insertion: <code>h(n)=1</code> (amortized constant),</li>
  319. <li>deletion: <code>d(n)=m</code>, where <code>m</code> is the distance
  320. from the deleted element to the end of the sequence,</li>
  321. <li>replacement: <code>r(n)=1</code> (constant),</li>
  322. <li>modifying: <code>m(n)=1</code> (constant).</li>
  323. </ul>
  324. The following expressions are also used as a convenience for writing down some
  325. of the complexity formulas:
  326. </p>
  327. <blockquote>
  328. <code>shl(a,b)</code> = <code>a+b</code> if a is nonzero, <code>0</code> otherwise.<br>
  329. <code>rel(a,b,c)</code> = if <code>a&lt;b</code>, <code>c-a</code>, else <code>a-b</code>,
  330. </blockquote>
  331. <p>
  332. (<code>shl</code> and <code>rel</code> stand for <i>shift left</i> and
  333. <i>relocate</i>, respectively.)
  334. </p>
  335. <h4><a name="instantiation_types">Instantiation types</a></h4>
  336. <p>Random access indices are instantiated internally to <code>multi_index_container</code>
  337. and specified by means of <a href="indices.html#indexed_by">
  338. <code>indexed_by</code></a> with the <a href="#random_access"><code>random_access</code></a>
  339. index specifier. Instantiations are dependent on the following types:
  340. <ul>
  341. <li><code>Value</code> from <code>multi_index_container</code>,</li>
  342. <li><code>Allocator</code> from <code>multi_index_container</code>,</li>
  343. <li><code>TagList</code> from the index specifier (if provided, otherwise <code>tag&lt;&gt;</code> is assumed).</li>
  344. </ul>
  345. <code>TagList</code> must be an instantiation of
  346. <a href="indices.html#tag"><code>tag</code></a>.
  347. </p>
  348. <h4><a name="constructors">Constructors, copy and assignment</a></h4>
  349. <p>
  350. As explained in the <a href="indices.html#index_concepts">index
  351. concepts section</a>, indices do not have public constructors or destructors.
  352. Assignment, on the other hand, is provided.
  353. </p>
  354. <code><b>index class name</b>&amp; operator=(const <b>index class name</b>&amp; x);</code>
  355. <blockquote>
  356. <b>Effects:</b>
  357. <blockquote><pre>
  358. <span class=identifier>a</span><span class=special>=</span><span class=identifier>b</span><span class=special>;</span>
  359. </pre></blockquote>
  360. where <code>a</code> and <code>b</code> are the <code>multi_index_container</code>
  361. objects to which <code>*this</code> and <code>x</code> belong, respectively.<br>
  362. <b>Returns:</b> <code>*this</code>.<br>
  363. </blockquote>
  364. <code><b>index class name</b>&amp; operator=(std::initializer_list&lt;value_type&gt; list);</code>
  365. <blockquote>
  366. <b>Effects:</b>
  367. <blockquote><pre>
  368. <span class=identifier>a</span><span class=special>=</span><span class=identifier>list</span><span class=special>;</span>
  369. </pre></blockquote>
  370. where <code>a</code> is the <code>multi_index_container</code>
  371. object to which <code>*this</code> belongs.<br>
  372. <b>Returns:</b> <code>*this</code>.<br>
  373. </blockquote>
  374. <code>template &lt;class InputIterator><br>
  375. void assign(InputIterator first,InputIterator last);</code>
  376. <blockquote>
  377. <b>Effects:</b>
  378. <blockquote><pre>
  379. <span class=identifier>clear</span><span class=special>();</span>
  380. <span class=identifier>insert</span><span class=special>(</span><span class=identifier>end</span><span class=special>(),</span><span class=identifier>first</span><span class=special>,</span><span class=identifier>last</span><span class=special>);</span>
  381. </pre></blockquote>
  382. </blockquote>
  383. <code>void assign(std::initializer_list&lt;value_type&gt; list);</code>
  384. <blockquote>
  385. <b>Effects:</b>
  386. <blockquote><pre>
  387. <span class=identifier>assign</span><span class=special>(</span><span class=identifier>list</span><span class=special>.</span><span class=identifier>begin</span><span class=special>(),</span><span class=identifier>list</span><span class=special>.</span><span class=identifier>end</span><span class=special>());</span>
  388. </pre></blockquote>
  389. </blockquote>
  390. <code>void assign(size_type n,const value_type&amp; value);</code>
  391. <blockquote>
  392. <b>Effects:</b>
  393. <blockquote><pre>
  394. <span class=identifier>clear</span><span class=special>();</span>
  395. <span class=keyword>for</span><span class=special>(</span><span class=identifier>size_type</span> <span class=identifier>i</span><span class=special>=</span><span class=number>0</span><span class=special>;</span><span class=identifier>i</span><span class=special>&lt;</span><span class=identifier>n</span><span class=special>;++</span><span class=identifier>n</span><span class=special>)</span><span class=identifier>push_back</span><span class=special>(</span><span class=identifier>v</span><span class=special>);</span>
  396. </pre></blockquote>
  397. </blockquote>
  398. <h4><a name="iterators">Iterators</a></h4>
  399. <code>iterator&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;iterator_to(const value_type&amp; x);<br>
  400. const_iterator iterator_to(const value_type&amp; x)const;</code>
  401. <blockquote>
  402. <b>Requires:</b> <code>x</code> is a reference to an element of the container.<br>
  403. <b>Returns:</b> An iterator to <code>x</code>.<br>
  404. <b>Complexity:</b> Constant.<br>
  405. <b>Exception safety:</b> <code>nothrow</code>.<br>
  406. </blockquote>
  407. <h4><a name="capacity">Capacity operations</a></h4>
  408. <a name="capacity_memfun"><code>size_type capacity()const noexcept;</code></a>
  409. <blockquote>
  410. <b>Returns:</b> The total number of elements <code>c</code> such that, when
  411. <code>size()&lt;c</code>, back insertions happen in constant time (the
  412. general case as described by
  413. <a href="#complexity_signature"><code>i(n)</code></a> is <i>amortized</i>
  414. constant time.)<br>
  415. <b>Note:</b> Validity of iterators and references to elements
  416. is preserved in all insertions, regardless of the capacity status.
  417. </blockquote>
  418. <a name="reserve"><code>void reserve(size_type m);</code></a>
  419. <blockquote>
  420. <b>Effects:</b> If the previous value of <code>capacity()</code>
  421. was greater than or equal to <code>m</code>, nothing is done;
  422. otherwise, the internal capacity is changed so that
  423. <code>capacity()>=m</code>.<br>
  424. <b>Complexity:</b> If the capacity is not changed, constant;
  425. otherwise <code>O(n)</code>.<br>
  426. <b>Exception safety:</b> If the capacity is not changed, <code>nothrow</code>;
  427. otherwise, strong.<br>
  428. </blockquote>
  429. <code>void shrink_to_fit();</code>
  430. <blockquote>
  431. <b>Effects:</b> Reduces <code>capacity()</code> to <code>size()</code>.<br>
  432. <b>Complexity:</b> If the capacity is not changed, constant;
  433. otherwise <code>O(n)</code>.<br>
  434. <b>Exception safety:</b> If the capacity is not changed, <code>nothrow</code>;
  435. otherwise, strong.<br>
  436. </blockquote>
  437. <code>void resize(size_type n);<br>
  438. void resize(size_type n,const value_type&amp; x);</code>
  439. <blockquote>
  440. <b>Requires (first version):</b> <code>value_type</code> is <code>DefaultInsertable</code>
  441. into <code>multi_index_container</code>.<br>
  442. <b>Requires (second version):</b> <code>value_type</code> is <code>CopyInsertable</code>
  443. into <code>multi_index_container</code>.<br>
  444. <b>Effects:</b> If <code>size()&lt;n</code>, tries to append <code>n-size()</code> default-inserted
  445. elements (first version) or copies of <code>x</code> (second version) at the end of
  446. the index. If <code>n&lt;size()</code>, erases the last <code>size()-n</code> elements.<br>
  447. <b>Note:</b> If an expansion is requested, the size of the index is not guaranteed
  448. to be <code>n</code> after this operation (other indices may ban insertions.)
  449. </blockquote>
  450. <h4><a name="modifiers">Modifiers</a></h4>
  451. <code>template&lt;typename... Args&gt;<br>
  452. std::pair&lt;iterator,bool&gt; emplace_front(Args&amp;&amp;... args);</code>
  453. <blockquote>
  454. <b>Effects:</b>
  455. <blockquote><pre>
  456. <span class=identifier>emplace</span><span class=special>(</span><span class=identifier>begin</span><span class=special>(),</span><span class=identifier>std</span><span class=special>::</span><span class=identifier>forward</span><span class=special>&lt;</span><span class=identifier>Args</span><span class=special>&gt;(</span><span class=identifier>args</span><span class=special>)...);</span>
  457. </pre></blockquote>
  458. <b>Returns:</b> The return value is a pair <code>p</code>. <code>p.second</code>
  459. is <code>true</code> if and only if insertion took place. On successful
  460. insertion, <code>p.first</code> points to the element inserted; otherwise,
  461. <code>p.first</code> points to an element that caused the insertion to be banned.
  462. Note that more than one element can be causing insertion not to be allowed.<br>
  463. </blockquote>
  464. <code>std::pair&lt;iterator,bool> push_front(const value_type&amp; x);</code><br>
  465. <code>std::pair&lt;iterator,bool> push_front(value_type&amp;&amp; x);</code>
  466. <blockquote>
  467. <b>Effects:</b>
  468. <blockquote><pre>
  469. <span class=identifier>insert</span><span class=special>(</span><span class=identifier>begin</span><span class=special>(),</span><span class=identifier>x</span><span class=special>);</span> <span class=comment>// lvalue ref version</span>
  470. <span class=identifier>insert</span><span class=special>(</span><span class=identifier>begin</span><span class=special>(),</span><span class=identifier>std</span><span class=special>::</span><span class=identifier>move</span><span class=special>(</span><span class=identifier>x</span><span class=special>));</span> <span class=comment>// rvalue ref version</span>
  471. </pre></blockquote>
  472. <b>Returns:</b> The return value is a pair <code>p</code>. <code>p.second</code>
  473. is <code>true</code> if and only if insertion took place. On successful
  474. insertion, <code>p.first</code> points to the element inserted; otherwise,
  475. <code>p.first</code> points to an element that caused the insertion to be banned.
  476. Note that more than one element can be causing insertion not to be allowed.<br>
  477. </blockquote>
  478. <code>template&lt;typename... Args&gt;<br>
  479. std::pair&lt;iterator,bool&gt; emplace_back(Args&amp;&amp;... args);</code>
  480. <blockquote>
  481. <b>Effects:</b>
  482. <blockquote><pre>
  483. <span class=identifier>emplace</span><span class=special>(</span><span class=identifier>end</span><span class=special>(),</span><span class=identifier>std</span><span class=special>::</span><span class=identifier>forward</span><span class=special>&lt;</span><span class=identifier>Args</span><span class=special>&gt;(</span><span class=identifier>args</span><span class=special>)...);</span>
  484. </pre></blockquote>
  485. <b>Returns:</b> The return value is a pair <code>p</code>. <code>p.second</code>
  486. is <code>true</code> if and only if insertion took place. On successful
  487. insertion, <code>p.first</code> points to the element inserted; otherwise,
  488. <code>p.first</code> points to an element that caused the insertion to be banned.
  489. Note that more than one element can be causing insertion not to be allowed.<br>
  490. </blockquote>
  491. <code>std::pair&lt;iterator,bool> push_back(const value_type&amp; x);</code><br>
  492. <code>std::pair&lt;iterator,bool> push_back(value_type&amp;&amp; x);</code>
  493. <blockquote>
  494. <b>Effects:</b>
  495. <blockquote><pre>
  496. <span class=identifier>insert</span><span class=special>(</span><span class=identifier>end</span><span class=special>(),</span><span class=identifier>x</span><span class=special>);</span> <span class=comment>// lvalue ref version</span>
  497. <span class=identifier>insert</span><span class=special>(</span><span class=identifier>end</span><span class=special>(),</span><span class=identifier>std</span><span class=special>::</span><span class=identifier>move</span><span class=special>(</span><span class=identifier>x</span><span class=special>));</span> <span class=comment>// rvalue ref version</span>
  498. </pre></blockquote>
  499. <b>Returns:</b> The return value is a pair <code>p</code>. <code>p.second</code>
  500. is <code>true</code> if and only if insertion took place. On successful
  501. insertion, <code>p.first</code> points to the element inserted; otherwise,
  502. <code>p.first</code> points to an element that caused the insertion to be banned.
  503. Note that more than one element can be causing insertion not to be allowed.<br>
  504. </blockquote>
  505. <code>template&lt;typename... Args&gt;<br>
  506. std::pair&lt;iterator,bool&gt; emplace(iterator position,Args&amp;&amp;... args);</code>
  507. <blockquote>
  508. <b>Requires:</b> <code>value_type</code> is <code>EmplaceConstructible</code>
  509. into <code>multi_index_container</code> from <code>args</code>.<br>
  510. <b>Effects:</b> Inserts a <code>value_type</code> object constructed with
  511. <code>std::forward&lt;Args&gt;(args)...</code> before <code>position</code> if insertion
  512. is allowed by all other indices of the <code>multi_index_container</code>.<br>
  513. <b>Returns:</b> The return value is a pair <code>p</code>. <code>p.second</code>
  514. is <code>true</code> if and only if insertion took place. On successful insertion,
  515. <code>p.first</code> points to the element inserted; otherwise, <code>p.first</code>
  516. points to an element that caused the insertion to be banned. Note that more than
  517. one element can be causing insertion not to be allowed.<br>
  518. <b>Complexity:</b> <code>O(I(n))</code>.<br>
  519. <b>Exception safety:</b> Strong.<br>
  520. </blockquote>
  521. <code>std::pair&lt;iterator,bool> insert(iterator position,const value_type&amp; x);</code><br>
  522. <code>std::pair&lt;iterator,bool> insert(iterator position,value_type&amp;&amp; x);</code>
  523. <blockquote>
  524. <b>Requires (first version):</b> <code>value_type</code> is <code>CopyInsertable</code>
  525. into <code>multi_index_container</code>.
  526. <code>position</code> is a valid iterator of the index.<br>
  527. <b>Requires (second version):</b> <code>value_type</code> is <code>MoveInsertable</code>
  528. into <code>multi_index_container</code>.
  529. <code>position</code> is a valid iterator of the index.<br>
  530. <b>Effects:</b> Inserts <code>x</code> before <code>position</code> if insertion
  531. is allowed by all other indices of the <code>multi_index_container</code>.<br>
  532. <b>Returns:</b> The return value is a pair <code>p</code>. <code>p.second</code>
  533. is <code>true</code> if and only if insertion took place. On successful
  534. insertion, <code>p.first</code> points to the element inserted; otherwise,
  535. <code>p.first</code> points to an element that caused the insertion to be banned.
  536. Note that more than one element can be causing insertion not to be allowed.<br>
  537. <b>Complexity:</b> <code>O(I(n))</code>.<br>
  538. <b>Exception safety:</b> Strong.
  539. </blockquote>
  540. <code>void insert(iterator position,size_type m,const value_type&amp; x);</code>
  541. <blockquote>
  542. <b>Requires:</b> <code>position</code> is a valid iterator of the index.<br>
  543. <b>Effects:</b>
  544. <blockquote><pre>
  545. <span class=keyword>for</span><span class=special>(</span><span class=identifier>size_type</span> <span class=identifier>i</span><span class=special>=</span><span class=number>0</span><span class=special>;</span><span class=identifier>i</span><span class=special>&lt;</span><span class=identifier>m</span><span class=special>;++</span><span class=identifier>i</span><span class=special>)</span><span class=identifier>insert</span><span class=special>(</span><span class=identifier>position</span><span class=special>,</span><span class=identifier>x</span><span class=special>);</span>
  546. </pre></blockquote>
  547. <b>Complexity:</b> <code>O(shl(end()-position,m) + m*I(n+m))</code>.
  548. </blockquote>
  549. <code>template&lt;typename InputIterator><br>
  550. void insert(iterator position,InputIterator first,InputIterator last);</code>
  551. <blockquote>
  552. <b>Requires:</b> <code>position</code> is a valid iterator of the index.
  553. <code>InputIterator</code> is an input iterator.
  554. <code>value_type</code> is
  555. <code>EmplaceConstructible</code> into
  556. <code>multi_index_container</code> from <code>*first</code>.
  557. <code>first</code> and <code>last</code> are not iterators into any
  558. index of the <code>multi_index_container</code> to which this index belongs.
  559. <code>last</code> is reachable from <code>first</code>.<br>
  560. <b>Effects:</b>
  561. For each element of [<code>first</code>, <code>last</code>), in this
  562. order, inserts it before <code>position</code> if insertion is allowed by all
  563. other indices of the <code>multi_index_container</code>.<br>
  564. <b>Complexity:</b> <code>O(shl(end()-position,m) + m*I(n+m))</code>,
  565. where <code>m</code> is the number of elements in
  566. [<code>first</code>,<code>last</code>).<br>
  567. <b>Exception safety:</b> Basic.
  568. </blockquote>
  569. <code>void insert(iterator position,std::initializer_list&lt;value_type&gt; list);</code>
  570. <blockquote>
  571. <b>Effects:</b>
  572. <blockquote><pre>
  573. <span class=identifier>insert</span><span class=special>(</span><span class=identifier>position</span><span class=special>,</span><span class=identifier>list</span><span class=special>.</span><span class=identifier>begin</span><span class=special>(),</span><span class=identifier>list</span><span class=special>.</span><span class=identifier>end</span><span class=special>());</span>
  574. </pre></blockquote>
  575. </blockquote>
  576. <code>iterator erase(iterator position);</code>
  577. <blockquote>
  578. <b>Requires:</b> <code>position</code> is a valid dereferenceable iterator
  579. of the index.<br>
  580. <b>Effects:</b> Deletes the element pointed to by <code>position</code>.<br>
  581. <b>Returns:</b> An iterator pointing to the element immediately following
  582. the one that was deleted, or <code>end()</code>
  583. if no such element exists.<br>
  584. <b>Complexity:</b> <code>O(D(n))</code>.<br>
  585. <b>Exception safety:</b> <code>nothrow</code>.<br>
  586. </blockquote>
  587. <code>iterator erase(iterator first,iterator last);</code>
  588. <blockquote>
  589. <b>Requires:</b> [<code>first</code>,<code>last</code>) is a valid
  590. range of the index.<br>
  591. <b>Effects:</b> Deletes the elements in [<code>first</code>,<code>last</code>).<br>
  592. <b>Returns:</b> <code>last</code>.<br>
  593. <b>Complexity:</b> <code>O(m*D(n))</code>, where <code>m</code> is
  594. the number of elements in [<code>first</code>,<code>last</code>).<br>
  595. <b>Exception safety:</b> <code>nothrow</code>.<br>
  596. </blockquote>
  597. <a name="replace"><code>bool replace(iterator position,const value_type&amp; x);</code></a><br>
  598. <code>bool replace(iterator position,value_type&amp;&amp; x);</code>
  599. <blockquote>
  600. <b>Requires (first version):</b> <code>value_type</code> is <code>CopyAssignable</code>.
  601. <code>position</code> is a valid dereferenceable iterator of the index.<br>
  602. <b>Requires (second version):</b> <code>value_type</code> is <code>MoveAssignable</code>.
  603. <code>position</code> is a valid dereferenceable iterator of the index.<br>
  604. <b>Effects:</b> Assigns the value <code>x</code> to the element pointed
  605. to by <code>position</code> into the <code>multi_index_container</code> to which
  606. the index belongs if replacing is allowed by all other indices of the
  607. <code>multi_index_container</code>.<br>
  608. <b>Postconditions:</b> Validity of <code>position</code> is preserved
  609. in all cases.<br>
  610. <b>Returns:</b> <code>true</code> if the replacement took place,
  611. <code>false</code> otherwise.<br>
  612. <b>Complexity:</b> <code>O(R(n))</code>.<br>
  613. <b>Exception safety:</b> Strong. If an exception is thrown by some
  614. user-provided operation the <code>multi_index_container</code> to which the index
  615. belongs remains in its original state.
  616. </blockquote>
  617. <a name="modify">
  618. <code>template&lt;typename Modifier> bool modify(iterator position,Modifier mod);</code></a>
  619. <blockquote>
  620. <b>Requires:</b> <code>mod</code> is a unary function object
  621. accepting arguments of type
  622. <code>value_type&amp;</code>. <code>position</code> is a valid dereferenceable
  623. iterator of the index.
  624. The execution of <code>mod(e)</code>, where <code>e</code> is the element
  625. pointed to by <code>position</code>, does not invoke any operation of the
  626. <code>multi_index_container</code> after <code>e</code> is directly modified
  627. or, before modification, if the operation would invalidate <code>position</code>.<br>
  628. <b>Effects:</b> Calls <code>mod(e)</code> where <code>e</code> is the element
  629. pointed to by <code>position</code> and rearranges <code>*position</code> into
  630. all the indices of the <code>multi_index_container</code>. Rearrangement on sequenced
  631. indices does not change the position of the element with respect to the index;
  632. rearrangement on other indices may or might not succeed. If the rearrangement
  633. fails, the element is erased.<br>
  634. <b>Postconditions:</b> Validity of <code>position</code> is preserved if the
  635. operation succeeds.<br>
  636. <b>Returns:</b> <code>true</code> if the operation succeeded, <code>false</code>
  637. otherwise.<br>
  638. <b>Complexity:</b> <code>O(M(n))</code>.<br>
  639. <b>Exception safety:</b> Basic. If an exception is thrown by some
  640. user-provided operation (including <code>mod</code>), then
  641. the element pointed to by <code>position</code> is erased.
  642. </blockquote>
  643. <code>template&lt;typename Modifier,typename Rollback><br>
  644. bool modify(iterator position,Modifier mod,Rollback back);</code>
  645. <blockquote>
  646. <b>Requires:</b> <code>mod</code> and <code>back</code> are unary function
  647. objects accepting arguments of type
  648. <code>value_type&amp;</code>. <code>position</code> is a valid dereferenceable
  649. iterator of the index.
  650. The execution of <code>mod(e)</code>, where <code>e</code> is the element
  651. pointed to by <code>position</code>, does not invoke any operation of the
  652. <code>multi_index_container</code> after <code>e</code> is directly modified
  653. or, before modification, if the operation would invalidate <code>position</code>.
  654. <code>back(e)</code> does not invoke any operation of the
  655. <code>multi_index_container</code>.<br>
  656. <b>Effects:</b> Calls <code>mod(e)</code> where <code>e</code> is the element
  657. pointed to by <code>position</code> and tries to rearrange <code>*position</code> into
  658. all the indices of the <code>multi_index_container</code>. Rearrangement on sequenced
  659. indices does not change the position of the element with respect to the index;
  660. rearrangement on other indices may or might not succeed.
  661. If the rearrangement fails, <code>back(e)</code> is invoked: if the resulting value
  662. of <code>e</code> is consistent with its original position and constraints in all
  663. indices, the element is kept, otherwise it is erased.<br>
  664. <b>Postconditions:</b> Validity of <code>position</code> is preserved except if
  665. the element is erased under the conditions described below.<br>
  666. <b>Returns:</b> <code>true</code> if the operation succeeded, <code>false</code>
  667. otherwise.<br>
  668. <b>Complexity:</b> <code>O(M(n))</code>.<br>
  669. <b>Exception safety:</b> Strong, except if <code>mod</code> or <code>back</code> throw an
  670. exception or <code>back(e)</code> fails to properly restore the element or there is
  671. a throwing user-provided operation after invoking <code>back(e)</code>, in which cases
  672. the modified element is erased. If <code>back</code>
  673. throws inside the handling code executing after some other user-provided
  674. operation has thrown, it is the exception generated by <code>back</code> that
  675. is rethrown.
  676. </blockquote>
  677. <h4><a name="list_operations">List operations</a></h4>
  678. <p>
  679. Random access indices replicate the interface of sequenced indices, which
  680. in turn includes the list operations provided by <code>std::list</code>.
  681. The syntax and behavior of these operations exactly matches those
  682. of sequenced indices, but the associated complexity bounds differ in general.
  683. </p>
  684. <code>void splice(iterator position,<b>index class name</b>&amp; x);</code>
  685. <blockquote>
  686. <b>Requires:</b> <code>position</code> is a valid iterator of the index.
  687. <code>&amp;x!=this</code>.<br>
  688. <b>Effects:</b> Inserts the contents of <code>x</code> before <code>position</code>,
  689. in the same order as they were in <code>x</code>. Those elements successfully
  690. inserted are erased from <code>x</code>.<br>
  691. <b>Complexity:</b> <code>O(shl(end()-position,x.size()) + x.size()*I(n+x.size()) + x.size()*D(x.size()))</code>.<br>
  692. <b>Exception safety:</b> Basic.<br>
  693. </blockquote>
  694. <code>void splice(iterator position,<b>index class name</b>&amp; x,iterator i);</code>
  695. <blockquote>
  696. <b>Requires:</b> <code>position</code> is a valid iterator of the index.
  697. <code>i</code> is a valid dereferenceable iterator <code>x</code>.<br>
  698. <b>Effects:</b> Inserts the element pointed to by <code>i</code> before
  699. <code>position</code>: if insertion is successful, the element is erased from
  700. <code>x</code>. In the special case <code>&amp;x==this</code>, no copy or
  701. deletion is performed, and the operation is always successful. If
  702. <code>position==i</code>, no operation is performed.<br>
  703. <b>Postconditions:</b> If <code>&amp;x==this</code>, no iterator or reference
  704. is invalidated.<br>
  705. <b>Complexity:</b> If <code>&amp;x==this</code>, <code>O(rel(position,i,i+1))</code>;
  706. otherwise <code>O(shl(end()-position,1) + I(n) + D(n))</code>.<br>
  707. <b>Exception safety:</b> If <code>&amp;x==this</code>, <code>nothrow</code>;
  708. otherwise, strong.<br>
  709. </blockquote>
  710. <code>void splice(iterator position,<b>index class name&amp;</b> x,iterator first,iterator last);</code>
  711. <blockquote>
  712. <b>Requires:</b> <code>position</code> is a valid iterator of the index.
  713. <code>first</code> and <code>last</code> are valid iterators of <code>x</code>.
  714. <code>last</code> is reachable from <code>first</code>. <code>position</code>
  715. is not in the range [<code>first</code>,<code>last</code>).<br>
  716. <b>Effects:</b> For each element in the range [<code>first</code>,<code>last</code>),
  717. insertion is tried before <code>position</code>; if the operation is successful,
  718. the element is erased from <code>x</code>. In the special case
  719. <code>&amp;x==this</code>, no copy or deletion is performed, and insertions are
  720. always successful.<br>
  721. <b>Postconditions:</b> If <code>&amp;x==this</code>, no iterator or reference
  722. is invalidated.<br>
  723. <b>Complexity:</b> If <code>&amp;x==this</code>,
  724. <code>O(rel(position,first,last))</code>; otherwise
  725. <code>O(shl(end()-position,m) + m*I(n+m) + m*D(x.size()))</code>
  726. where <code>m</code> is the number of elements in [<code>first</code>,<code>last</code>).<br>
  727. <b>Exception safety:</b> If <code>&amp;x==this</code>, <code>nothrow</code>;
  728. otherwise, basic.<br>
  729. </blockquote>
  730. <code>void remove(const value_type&amp; value);</code>
  731. <blockquote>
  732. <b>Effects:</b> Erases all elements of the index which compare equal to
  733. <code>value</code>.<br>
  734. <b>Complexity:</b> <code>O(n + m*D(n))</code>, where <code>m</code>
  735. is the number of elements erased.<br>
  736. <b>Exception safety:</b> Basic.
  737. </blockquote>
  738. <code>template&lt;typename Predicate> void remove_if(Predicate pred);</code>
  739. <blockquote>
  740. <b>Effects:</b> Erases all elements <code>x</code> of the index for which
  741. <code>pred(x)</code> holds.<br>
  742. <b>Complexity:</b> <code>O(n + m*D(n))</code>, where <code>m</code>
  743. is the number of elements erased.<br>
  744. <b>Exception safety:</b> Basic.
  745. </blockquote>
  746. <code>void unique();</code>
  747. <blockquote>
  748. <b>Effects:</b> Eliminates all but the first element from every consecutive
  749. group of equal elements referred to by the iterator <code>i</code> in the range
  750. [<code>first+1</code>,<code>last</code>) for which <code>*i==*(i-1)</code>.<br>
  751. <b>Complexity:</b> <code>O(n + m*D(n))</code>, where <code>m</code>
  752. is the number of elements erased.<br>
  753. <b>Exception safety:</b> Basic.
  754. </blockquote>
  755. <code>template &lt;class BinaryPredicate> void unique(BinaryPredicate binary_pred);</code>
  756. <blockquote>
  757. <b>Effects:</b> Eliminates all but the first element from every consecutive
  758. group of elements referred to by the iterator <code>i</code> in the range
  759. [<code>first+1</code>,<code>last</code>) for which
  760. <code>binary_pred(*i,*(i-1))</code> holds.<br>
  761. <b>Complexity:</b> <code>O(n + m*D(n))</code>, where <code>m</code>
  762. is the number of elements erased.<br>
  763. <b>Exception safety:</b> Basic.
  764. </blockquote>
  765. <code>void merge(index class name&amp; x);</code>
  766. <blockquote>
  767. <b>Requires:</b> <code>std::less&lt;value_type&gt;</code> induces a
  768. strict weak ordering over <code>value_type</code>.
  769. Both the index and <code>x</code> are sorted according to
  770. <code>std::less&lt;value_type&gt;</code>.<br>
  771. <b>Effects:</b> Attempts to insert every element of <code>x</code> into the
  772. corresponding position of the index (according to the order). Elements
  773. successfully inserted are erased from <code>x</code>. The resulting sequence
  774. is stable, i.e. equivalent elements of either container preserve their
  775. relative position. In the special case <code>&amp;x==this</code>, no operation
  776. is performed.<br>
  777. <b>Postconditions:</b> Elements in the index and remaining elements in
  778. <code>x</code> are sorted.
  779. Validity of iterators to the index and of non-erased elements of <code>x</code>
  780. references is preserved.<br>
  781. <b>Complexity:</b> If <code>&amp;x==this</code>, constant; otherwise
  782. <code>O(n + x.size()*I(n+x.size()) + x.size()*D(x.size()))</code>.<br>
  783. <b>Exception safety:</b> If <code>&amp;x==this</code>, <code>nothrow</code>;
  784. otherwise, basic.<br>
  785. </blockquote>
  786. <code>template &lt;typename Compare> void merge(index class name&amp; x,Compare comp);</code>
  787. <blockquote>
  788. <b>Requires:</b> <code>Compare</code> induces a
  789. strict weak ordering over <code>value_type</code>.
  790. Both the index and <code>x</code> are sorted according to <code>comp</code>.<br>
  791. <b>Effects:</b> Attempts to insert every element of <code>x</code> into the
  792. corresponding position of the index (according to <code>comp</code>).
  793. Elements successfully inserted are erased from <code>x</code>. The resulting
  794. sequence is stable, i.e. equivalent elements of either container preserve
  795. their relative position. In the special case <code>&amp;x==this</code>, no
  796. operation is performed.<br>
  797. <b>Postconditions:</b> Elements in the index and remaining elements in
  798. <code>x</code> are sorted according to <code>comp</code>.
  799. Validity of iterators to the index and of non-erased elements of <code>x</code>
  800. references is preserved.<br>
  801. <b>Complexity:</b> If <code>&amp;x==this</code>, constant; otherwise
  802. <code>O(n + x.size()*I(n+x.size()) + x.size()*D(x.size()))</code>.<br>
  803. <b>Exception safety:</b> If <code>&amp;x==this</code>, <code>nothrow</code>;
  804. otherwise, basic.<br>
  805. </blockquote>
  806. <code>void sort();</code>
  807. <blockquote>
  808. <b>Requires:</b> <code>std::less&lt;value_type&gt;</code> induces a
  809. strict weark ordering over <code>value_type</code>.<br>
  810. <b>Effects:</b> Sorts the index according to
  811. <code>std::less&lt;value_type></code>. The sorting is stable, i.e.
  812. equivalent elements preserve their relative position.<br>
  813. <b>Postconditions:</b> Validity of iterators and references is preserved.<br>
  814. <b>Complexity:</b> <code>O(n*log(n))</code>.<br>
  815. <b>Exception safety:</b> Basic.
  816. </blockquote>
  817. <code>template &lt;typename Compare> void sort(Compare comp);</code>
  818. <blockquote>
  819. <b>Requires:</b> <code>Compare</code> induces a
  820. strict weak ordering over <code>value_type</code>.<br>
  821. <b>Effects:</b> Sorts the index according to <code>comp</code>. The sorting
  822. is stable, i.e. equivalent elements preserve their relative position.<br>
  823. <b>Postconditions:</b> Validity of iterators and references is preserved.<br>
  824. <b>Complexity:</b> <code>O(n*log(n))</code>.<br>
  825. <b>Exception safety:</b> Basic.
  826. </blockquote>
  827. <code>void reverse()noexcept;</code>
  828. <blockquote>
  829. <b>Effects:</b> Reverses the order of the elements in the index.<br>
  830. <b>Postconditions:</b> Validity of iterators and references is preserved.<br>
  831. <b>Complexity:</b> <code>O(n)</code>.<br>
  832. </blockquote>
  833. <h4><a name="rearrange_operations">Rearrange operations</a></h4>
  834. <p>
  835. These operations, without counterpart in STL sequence containers
  836. (although <code>std::list::splice</code> provides partially overlapping
  837. functionality), perform individual and global repositioning of elements
  838. inside the index.
  839. </p>
  840. <code>void relocate(iterator position,iterator i);</code>
  841. <blockquote>
  842. <b>Requires:</b> <code>position</code> is a valid iterator of the index.
  843. <code>i</code> is a valid dereferenceable iterator of the index.<br>
  844. <b>Effects:</b> Inserts the element pointed to by <code>i</code> before
  845. <code>position</code>. If <code>position==i</code>, no operation is
  846. performed.<br>
  847. <b>Postconditions:</b> No iterator or reference is invalidated.<br>
  848. <b>Complexity:</b> <code>O(rel(position,i,i+1))</code>.<br>
  849. <b>Exception safety:</b> <code>nothrow</code>.<br>
  850. </blockquote>
  851. <code>void relocate(iterator position,iterator first,iterator last);</code>
  852. <blockquote>
  853. <b>Requires:</b> <code>position</code> is a valid iterator of the index.
  854. <code>first</code> and <code>last</code> are valid iterators of the index.
  855. <code>last</code> is reachable from <code>first</code>. <code>position</code>
  856. is not in the range [<code>first</code>,<code>last</code>).<br>
  857. <b>Effects:</b> The range of elements [<code>first</code>,<code>last</code>)
  858. is repositioned just before <code>position</code>.<br>
  859. <b>Postconditions:</b> No iterator or reference is invalidated.<br>
  860. <b>Complexity:</b> <code>O(rel(position,first,last))</code>.<br>
  861. <b>Exception safety:</b> <code>nothrow</code>.<br>
  862. </blockquote>
  863. <a name="rearrange"><code>template&lt;typename InputIterator> void rearrange(InputIterator first);</code></a>
  864. <blockquote>
  865. <b>Requires:</b> The range [<code>first</code>,
  866. <code>std::advance(first,n)</code>),
  867. where <code>n</code> is the size of the index, is a
  868. <a href="indices.html#views">free view</a> of the index.<br>
  869. <b>Effects:</b> The elements are rearranged so as to match the
  870. order of the previously described view.<br>
  871. <b>Postconditions:</b> No iterator or reference is invalidated.<br>
  872. <b>Complexity:</b> <code>O(n)</code>.<br>
  873. <b>Exception safety:</b> Basic.<br>
  874. </blockquote>
  875. <h4><a name="serialization">Serialization</a></h4>
  876. <p>
  877. Indices cannot be serialized on their own, but only as part of the
  878. <code>multi_index_container</code> into which they are embedded. In describing
  879. the additional preconditions and guarantees associated to random access indices
  880. with respect to serialization of their embedding containers, we
  881. use the concepts defined in the <code>multi_index_container</code>
  882. <a href="multi_index_container.html#serialization">serialization section</a>.
  883. </p>
  884. Operation: saving of a <code>multi_index_container</code> <code>m</code> to an
  885. output archive (XML archive) <code>ar</code>.
  886. <blockquote>
  887. <b>Requires:</b> No additional requirements to those imposed by the container.
  888. </blockquote>
  889. Operation: loading of a <code>multi_index_container</code> <code>m'</code> from an
  890. input archive (XML archive) <code>ar</code>.
  891. <blockquote>
  892. <b>Requires:</b> No additional requirements to those imposed by the container.<br>
  893. <b>Postconditions:</b> On successful loading, each of the elements of
  894. [<code>begin()</code>, <code>end()</code>) is a restored copy of the corresponding
  895. element in [<code>m.get&lt;i&gt;().begin()</code>, <code>m.get&lt;i&gt;().end()</code>),
  896. where <code>i</code> is the position of the random access index in the container.
  897. </blockquote>
  898. Operation: saving of an <code>iterator</code> or <code>const_iterator</code>
  899. <code>it</code> to an output archive (XML archive) <code>ar</code>.
  900. <blockquote>
  901. <b>Requires:</b> <code>it</code> is a valid iterator of the index. The associated
  902. <code>multi_index_container</code> has been previously saved.
  903. </blockquote>
  904. Operation: loading of an <code>iterator</code> or <code>const_iterator</code>
  905. <code>it'</code> from an input archive (XML archive) <code>ar</code>.
  906. <blockquote>
  907. <b>Postconditions:</b> On successful loading, if <code>it</code> was dereferenceable
  908. then <code>*it'</code> is the restored copy of <code>*it</code>, otherwise
  909. <code>it'==end()</code>.<br>
  910. <b>Note:</b> It is allowed that <code>it</code> be a <code>const_iterator</code>
  911. and the restored <code>it'</code> an <code>iterator</code>, or viceversa.
  912. </blockquote>
  913. <hr>
  914. <div class="prev_link"><a href="seq_indices.html"><img src="../prev.gif" alt="sequenced indices" border="0"><br>
  915. Sequenced indices
  916. </a></div>
  917. <div class="up_link"><a href="index.html"><img src="../up.gif" alt="Boost.MultiIndex reference" border="0"><br>
  918. Boost.MultiIndex reference
  919. </a></div>
  920. <div class="next_link"><a href="key_extraction.html"><img src="../next.gif" alt="key extraction" border="0"><br>
  921. Key extraction
  922. </a></div><br clear="all" style="clear: all;">
  923. <br>
  924. <p>Revised December 29th 2018</p>
  925. <p>&copy; Copyright 2003-2018 Joaqu&iacute;n M L&oacute;pez Mu&ntilde;oz.
  926. Distributed under the Boost Software
  927. License, Version 1.0. (See accompanying file <a href="../../../../LICENSE_1_0.txt">
  928. LICENSE_1_0.txt</a> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt">
  929. http://www.boost.org/LICENSE_1_0.txt</a>)
  930. </p>
  931. </body>
  932. </html>