1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>merge</title> 5<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../../../index.html" title="Chapter 1. Range 2.0"> 8<link rel="up" href="../mutating.html" title="Mutating algorithms"> 9<link rel="prev" href="inplace_merge.html" title="inplace_merge"> 10<link rel="next" href="nth_element.html" title="nth_element"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<table cellpadding="2" width="100%"><tr> 14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td> 15<td align="center"><a href="../../../../../../../../index.html">Home</a></td> 16<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td> 17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 19<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td> 20</tr></table> 21<hr> 22<div class="spirit-nav"> 23<a accesskey="p" href="inplace_merge.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="nth_element.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h5 class="title"> 27<a name="range.reference.algorithms.mutating.merge"></a><a class="link" href="merge.html" title="merge">merge</a> 28</h5></div></div></div> 29<h6> 30<a name="range.reference.algorithms.mutating.merge.h0"></a> 31 <span class="phrase"><a name="range.reference.algorithms.mutating.merge.prototype"></a></span><a class="link" href="merge.html#range.reference.algorithms.mutating.merge.prototype">Prototype</a> 32 </h6> 33<p> 34</p> 35<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> 36 <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> 37 <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span> 38 <span class="keyword">class</span> <span class="identifier">OutputIterator</span> 39 <span class="special">></span> 40<span class="identifier">OutputIterator</span> <span class="identifier">merge</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> 41 <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> 42 <span class="identifier">OutputIterator</span> <span class="identifier">out</span><span class="special">);</span> 43 44<span class="keyword">template</span><span class="special"><</span> 45 <span class="keyword">class</span> <span class="identifier">SinglePassRange1</span><span class="special">,</span> 46 <span class="keyword">class</span> <span class="identifier">SinglePassRange2</span><span class="special">,</span> 47 <span class="keyword">class</span> <span class="identifier">OutputIterator</span><span class="special">,</span> 48 <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span> 49 <span class="special">></span> 50<span class="identifier">OutputIterator</span> <span class="identifier">merge</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">SinglePassRange1</span><span class="special">&</span> <span class="identifier">rng1</span><span class="special">,</span> 51 <span class="keyword">const</span> <span class="identifier">SinglePassRange2</span><span class="special">&</span> <span class="identifier">rng2</span><span class="special">,</span> 52 <span class="identifier">OutputIterator</span> <span class="identifier">out</span><span class="special">,</span> 53 <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span><span class="special">);</span> 54</pre> 55<p> 56 </p> 57<h6> 58<a name="range.reference.algorithms.mutating.merge.h1"></a> 59 <span class="phrase"><a name="range.reference.algorithms.mutating.merge.description"></a></span><a class="link" href="merge.html#range.reference.algorithms.mutating.merge.description">Description</a> 60 </h6> 61<p> 62 <code class="computeroutput"><span class="identifier">merge</span></code> combines two sorted 63 ranges <code class="computeroutput"><span class="identifier">rng1</span></code> and <code class="computeroutput"><span class="identifier">rng2</span></code> into a single sorted range by 64 copying elements. <code class="computeroutput"><span class="identifier">merge</span></code> 65 is stable. The return value is <code class="computeroutput"><span class="identifier">out</span> 66 <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span> <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">)</span></code>. 67 </p> 68<p> 69 The two versions of <code class="computeroutput"><span class="identifier">merge</span></code> 70 differ by how they compare the elements. 71 </p> 72<p> 73 The non-predicate version uses the <code class="computeroutput"><span class="keyword">operator</span><span class="special"><()</span></code> for the range value type. The predicate 74 version uses the predicate instead of <code class="computeroutput"><span class="keyword">operator</span><span class="special"><()</span></code>. 75 </p> 76<h6> 77<a name="range.reference.algorithms.mutating.merge.h2"></a> 78 <span class="phrase"><a name="range.reference.algorithms.mutating.merge.definition"></a></span><a class="link" href="merge.html#range.reference.algorithms.mutating.merge.definition">Definition</a> 79 </h6> 80<p> 81 Defined in the header file <code class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">range</span><span class="special">/</span><span class="identifier">algorithm</span><span class="special">/</span><span class="identifier">merge</span><span class="special">.</span><span class="identifier">hpp</span></code> 82 </p> 83<h6> 84<a name="range.reference.algorithms.mutating.merge.h3"></a> 85 <span class="phrase"><a name="range.reference.algorithms.mutating.merge.requirements"></a></span><a class="link" href="merge.html#range.reference.algorithms.mutating.merge.requirements">Requirements</a> 86 </h6> 87<p> 88 <span class="bold"><strong>For the non-predicate version:</strong></span> 89 </p> 90<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 91<li class="listitem"> 92 <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> 93 is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single 94 Pass Range</a> Concept. 95 </li> 96<li class="listitem"> 97 <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> 98 is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single 99 Pass Range</a> Concept. 100 </li> 101<li class="listitem"> 102 <code class="computeroutput"><span class="identifier">range_value</span><span class="special"><</span><span class="identifier">SinglePassRange1</span><span class="special">>::</span><span class="identifier">type</span></code> is the same as <code class="computeroutput"><span class="identifier">range_value</span><span class="special"><</span><span class="identifier">SinglePassRange2</span><span class="special">>::</span><span class="identifier">type</span></code>. 103 </li> 104<li class="listitem"> 105 <code class="computeroutput"><span class="identifier">range_value</span><span class="special"><</span><span class="identifier">SinglePassRange1</span><span class="special">>::</span><span class="identifier">type</span></code> is a model of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>. 106 </li> 107<li class="listitem"> 108 The ordering on objects of <code class="computeroutput"><span class="identifier">range_value</span><span class="special"><</span><span class="identifier">SinglePassRange1</span><span class="special">>::</span><span class="identifier">type</span></code> 109 is a <span class="bold"><strong><span class="emphasis"><em>strict weak ordering</em></span></strong></span>, 110 as defined in the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code> 111 requirements. 112 </li> 113<li class="listitem"> 114 <code class="computeroutput"><span class="identifier">range_value</span><span class="special"><</span><span class="identifier">SinglePassRange1</span><span class="special">>::</span><span class="identifier">type</span></code> is convertible to a type in 115 <code class="computeroutput"><span class="identifier">OutputIterator</span></code>'s 116 set of value types. 117 </li> 118</ul></div> 119<p> 120 <span class="bold"><strong>For the predicate version:</strong></span> 121 </p> 122<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 123<li class="listitem"> 124 <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code> 125 is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single 126 Pass Range</a> Concept. 127 </li> 128<li class="listitem"> 129 <code class="computeroutput"><span class="identifier">SinglePassRange2</span></code> 130 is a model of the <a class="link" href="../../../concepts/single_pass_range.html" title="Single Pass Range">Single 131 Pass Range</a> Concept. 132 </li> 133<li class="listitem"> 134 <code class="computeroutput"><span class="identifier">range_value</span><span class="special"><</span><span class="identifier">SinglePassRange1</span><span class="special">>::</span><span class="identifier">type</span></code> is the same as <code class="computeroutput"><span class="identifier">range_value</span><span class="special"><</span><span class="identifier">SinglePassRange2</span><span class="special">>::</span><span class="identifier">type</span></code>. 135 </li> 136<li class="listitem"> 137 <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code> is 138 a model of the <code class="computeroutput"><span class="identifier">StrictWeakOrderingConcept</span></code>. 139 </li> 140<li class="listitem"> 141 <code class="computeroutput"><span class="identifier">SinglePassRange1</span></code>'s 142 value type is convertible to both <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s 143 argument types. 144 </li> 145<li class="listitem"> 146 <code class="computeroutput"><span class="identifier">range_value</span><span class="special"><</span><span class="identifier">SinglePassRange1</span><span class="special">>::</span><span class="identifier">type</span></code> is convertible to a type in 147 <code class="computeroutput"><span class="identifier">OutputIterator</span></code>'s 148 set of value types. 149 </li> 150</ul></div> 151<h6> 152<a name="range.reference.algorithms.mutating.merge.h4"></a> 153 <span class="phrase"><a name="range.reference.algorithms.mutating.merge.precondition_"></a></span><a class="link" href="merge.html#range.reference.algorithms.mutating.merge.precondition_">Precondition:</a> 154 </h6> 155<h6> 156<a name="range.reference.algorithms.mutating.merge.h5"></a> 157 <span class="phrase"><a name="range.reference.algorithms.mutating.merge.for_the_non_predicate_version_"></a></span><a class="link" href="merge.html#range.reference.algorithms.mutating.merge.for_the_non_predicate_version_">For 158 the non-predicate version:</a> 159 </h6> 160<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 161<li class="listitem"> 162 The elements of <code class="computeroutput"><span class="identifier">rng1</span></code> 163 are in ascending order. That is, for each adjacent element pair 164 <code class="computeroutput"><span class="special">[</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">]</span></code> of <code class="computeroutput"><span class="identifier">rng1</span></code>, 165 <code class="computeroutput"><span class="identifier">y</span> <span class="special"><</span> 166 <span class="identifier">x</span> <span class="special">==</span> 167 <span class="keyword">false</span></code>. 168 </li> 169<li class="listitem"> 170 The elements of <code class="computeroutput"><span class="identifier">rng2</span></code> 171 are in ascending order. That is, for each adjacent element pair 172 <code class="computeroutput"><span class="special">[</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">]</span></code> of <code class="computeroutput"><span class="identifier">rng2</span></code>, 173 <code class="computeroutput"><span class="identifier">y</span> <span class="special"><</span> 174 <span class="identifier">x</span> <span class="special">==</span> 175 <span class="keyword">false</span></code>. 176 </li> 177<li class="listitem"> 178 The ranges <code class="computeroutput"><span class="identifier">rng1</span></code> and 179 <code class="computeroutput"><span class="special">[</span><span class="identifier">out</span><span class="special">,</span> <span class="identifier">out</span> 180 <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span> <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">))</span></code> 181 do not overlap. 182 </li> 183<li class="listitem"> 184 The ranges <code class="computeroutput"><span class="identifier">rng2</span></code> and 185 <code class="computeroutput"><span class="special">[</span><span class="identifier">out</span><span class="special">,</span> <span class="identifier">out</span> 186 <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span> <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">))</span></code> 187 do not overlap. 188 </li> 189<li class="listitem"> 190 <code class="computeroutput"><span class="special">[</span><span class="identifier">out</span><span class="special">,</span> <span class="identifier">out</span> 191 <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span> <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">))</span></code> 192 is a valid range. 193 </li> 194</ul></div> 195<h6> 196<a name="range.reference.algorithms.mutating.merge.h6"></a> 197 <span class="phrase"><a name="range.reference.algorithms.mutating.merge.for_the_predicate_version_"></a></span><a class="link" href="merge.html#range.reference.algorithms.mutating.merge.for_the_predicate_version_">For 198 the predicate version:</a> 199 </h6> 200<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 201<li class="listitem"> 202 The elements of <code class="computeroutput"><span class="identifier">rng1</span></code> 203 are in ascending order. That is, for each adjacent element pair 204 <code class="computeroutput"><span class="special">[</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">]</span></code>, of <code class="computeroutput"><span class="identifier">rng1</span></code>, 205 <code class="computeroutput"><span class="identifier">pred</span><span class="special">(</span><span class="identifier">y</span><span class="special">,</span> <span class="identifier">x</span><span class="special">)</span> <span class="special">==</span> <span class="keyword">false</span></code>. 206 </li> 207<li class="listitem"> 208 The elements of <code class="computeroutput"><span class="identifier">rng2</span></code> 209 are in ascending order. That is, for each adjacent element pair 210 <code class="computeroutput"><span class="special">[</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">]</span></code>, of <code class="computeroutput"><span class="identifier">rng2</span></code>, 211 <code class="computeroutput"><span class="identifier">pred</span><span class="special">(</span><span class="identifier">y</span><span class="special">,</span> <span class="identifier">x</span><span class="special">)</span> <span class="special">==</span> <span class="keyword">false</span></code>. 212 </li> 213<li class="listitem"> 214 The ranges <code class="computeroutput"><span class="identifier">rng1</span></code> and 215 <code class="computeroutput"><span class="special">[</span><span class="identifier">out</span><span class="special">,</span> <span class="identifier">out</span> 216 <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span> <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">))</span></code> 217 do not overlap. 218 </li> 219<li class="listitem"> 220 The ranges <code class="computeroutput"><span class="identifier">rng2</span></code> and 221 <code class="computeroutput"><span class="special">[</span><span class="identifier">out</span><span class="special">,</span> <span class="identifier">out</span> 222 <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span> <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">))</span></code> 223 do not overlap. 224 </li> 225<li class="listitem"> 226 <code class="computeroutput"><span class="special">[</span><span class="identifier">out</span><span class="special">,</span> <span class="identifier">out</span> 227 <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span> <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">))</span></code> 228 is a valid range. 229 </li> 230</ul></div> 231<h6> 232<a name="range.reference.algorithms.mutating.merge.h7"></a> 233 <span class="phrase"><a name="range.reference.algorithms.mutating.merge.complexity"></a></span><a class="link" href="merge.html#range.reference.algorithms.mutating.merge.complexity">Complexity</a> 234 </h6> 235<p> 236 Linear. There are no comparisons if both <code class="computeroutput"><span class="identifier">rng1</span></code> 237 and <code class="computeroutput"><span class="identifier">rng2</span></code> are empty, otherwise 238 at most <code class="computeroutput"><span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng1</span><span class="special">)</span> <span class="special">+</span> <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng2</span><span class="special">)</span> <span class="special">-</span> <span class="number">1</span></code> 239 comparisons. 240 </p> 241</div> 242<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 243<td align="left"></td> 244<td align="right"><div class="copyright-footer">Copyright © 2003-2010 Thorsten Ottosen, 245 Neil Groves<p> 246 Distributed under the Boost Software License, Version 1.0. (See accompanying 247 file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) 248 </p> 249</div></td> 250</tr></table> 251<hr> 252<div class="spirit-nav"> 253<a accesskey="p" href="inplace_merge.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mutating.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="nth_element.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 254</div> 255</body> 256</html> 257
