• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>inplace_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="generate.html" title="generate">
10<link rel="next" href="merge.html" title="merge">
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="generate.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="merge.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.inplace_merge"></a><a class="link" href="inplace_merge.html" title="inplace_merge">inplace_merge</a>
28</h5></div></div></div>
29<h6>
30<a name="range.reference.algorithms.mutating.inplace_merge.h0"></a>
31            <span class="phrase"><a name="range.reference.algorithms.mutating.inplace_merge.prototype"></a></span><a class="link" href="inplace_merge.html#range.reference.algorithms.mutating.inplace_merge.prototype">Prototype</a>
32          </h6>
33<p>
34</p>
35<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">BidirectionalRange</span><span class="special">&gt;</span>
36<span class="identifier">BidirectionalRange</span><span class="special">&amp;</span>
37<span class="identifier">inplace_merge</span><span class="special">(</span> <span class="identifier">BidirectionalRange</span><span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">,</span>
38               <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="identifier">BidirectionalRange</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">middle</span> <span class="special">);</span>
39
40<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">BidirectionalRange</span><span class="special">&gt;</span>
41<span class="keyword">const</span> <span class="identifier">BidirectionalRange</span><span class="special">&amp;</span>
42<span class="identifier">inplace_merge</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">BidirectionalRange</span><span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">,</span>
43               <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="keyword">const</span> <span class="identifier">BidirectionalRange</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">middle</span> <span class="special">);</span>
44
45<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">BidirectionalRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span><span class="special">&gt;</span>
46<span class="identifier">BidirectionalRange</span><span class="special">&amp;</span>
47<span class="identifier">inplace_merge</span><span class="special">(</span> <span class="identifier">BidirectionalRange</span><span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">,</span>
48               <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="identifier">BidirectionalRange</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">middle</span><span class="special">,</span>
49               <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span> <span class="special">);</span>
50
51<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">BidirectionalRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">BinaryPredicate</span><span class="special">&gt;</span>
52<span class="keyword">const</span> <span class="identifier">BidirectionalRange</span><span class="special">&amp;</span>
53<span class="identifier">inplace_merge</span><span class="special">(</span> <span class="keyword">const</span> <span class="identifier">BidirectionalRange</span><span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">,</span>
54               <span class="keyword">typename</span> <span class="identifier">range_iterator</span><span class="special">&lt;</span><span class="keyword">const</span> <span class="identifier">BidirectionalRange</span><span class="special">&gt;::</span><span class="identifier">type</span> <span class="identifier">middle</span><span class="special">,</span>
55               <span class="identifier">BinaryPredicate</span> <span class="identifier">pred</span> <span class="special">);</span>
56</pre>
57<p>
58          </p>
59<h6>
60<a name="range.reference.algorithms.mutating.inplace_merge.h1"></a>
61            <span class="phrase"><a name="range.reference.algorithms.mutating.inplace_merge.description"></a></span><a class="link" href="inplace_merge.html#range.reference.algorithms.mutating.inplace_merge.description">Description</a>
62          </h6>
63<p>
64            <code class="computeroutput"><span class="identifier">inplace_merge</span></code> combines
65            two consecutive sorted ranges <code class="computeroutput"><span class="special">[</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">middle</span><span class="special">)</span></code>
66            and <code class="computeroutput"><span class="special">[</span><span class="identifier">middle</span><span class="special">,</span> <span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> into a single sorted range <code class="computeroutput"><span class="special">[</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code>. That is, it starts with a range <code class="computeroutput"><span class="special">[</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> that consists of two pieces each of
67            which is in ascending order, and rearranges it so that the entire range
68            is in ascending order. <code class="computeroutput"><span class="identifier">inplace_merge</span></code>
69            is stable, meaning both that the relative order of elements within each
70            input range is preserved.
71          </p>
72<h6>
73<a name="range.reference.algorithms.mutating.inplace_merge.h2"></a>
74            <span class="phrase"><a name="range.reference.algorithms.mutating.inplace_merge.definition"></a></span><a class="link" href="inplace_merge.html#range.reference.algorithms.mutating.inplace_merge.definition">Definition</a>
75          </h6>
76<p>
77            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">inplace_merge</span><span class="special">.</span><span class="identifier">hpp</span></code>
78          </p>
79<h6>
80<a name="range.reference.algorithms.mutating.inplace_merge.h3"></a>
81            <span class="phrase"><a name="range.reference.algorithms.mutating.inplace_merge.requirements"></a></span><a class="link" href="inplace_merge.html#range.reference.algorithms.mutating.inplace_merge.requirements">Requirements</a>
82          </h6>
83<p>
84            <span class="bold"><strong>For the non-predicate version:</strong></span>
85          </p>
86<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
87<li class="listitem">
88                <code class="computeroutput"><span class="identifier">BidirectionalRange</span></code>
89                is a model of the <a class="link" href="../../../concepts/bidirectional_range.html" title="Bidirectional Range">Bidirectional
90                Range</a> Concept.
91              </li>
92<li class="listitem">
93                <code class="computeroutput"><span class="identifier">BidirectionalRange</span></code>
94                is mutable.
95              </li>
96<li class="listitem">
97                <code class="computeroutput"><span class="identifier">range_value</span><span class="special">&lt;</span><span class="identifier">BidirectionalRange</span><span class="special">&gt;::</span><span class="identifier">type</span></code> is a model of <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>
98              </li>
99<li class="listitem">
100                The ordering on objects of <code class="computeroutput"><span class="identifier">range_type</span><span class="special">&lt;</span><span class="identifier">BidirectionalRange</span><span class="special">&gt;::</span><span class="identifier">type</span></code>
101                is a <span class="bold"><strong><span class="emphasis"><em>strict weak ordering</em></span></strong></span>,
102                as defined in the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>
103                requirements.
104              </li>
105</ul></div>
106<p>
107            <span class="bold"><strong>For the predicate version:</strong></span> * <code class="computeroutput"><span class="identifier">BidirectionalRange</span></code> is a model of the
108            <a class="link" href="../../../concepts/bidirectional_range.html" title="Bidirectional Range">Bidirectional Range</a>
109            Concept. * <code class="computeroutput"><span class="identifier">BidirectionalRange</span></code>
110            is mutable. * <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>
111            is a model of the <code class="computeroutput"><span class="identifier">StrictWeakOrderingConcept</span></code>.
112            * <code class="computeroutput"><span class="identifier">BidirectionalRange</span></code>'s
113            value type is convertible to both <code class="computeroutput"><span class="identifier">BinaryPredicate</span></code>'s
114            argument types.
115          </p>
116<h6>
117<a name="range.reference.algorithms.mutating.inplace_merge.h4"></a>
118            <span class="phrase"><a name="range.reference.algorithms.mutating.inplace_merge.precondition_"></a></span><a class="link" href="inplace_merge.html#range.reference.algorithms.mutating.inplace_merge.precondition_">Precondition:</a>
119          </h6>
120<h6>
121<a name="range.reference.algorithms.mutating.inplace_merge.h5"></a>
122            <span class="phrase"><a name="range.reference.algorithms.mutating.inplace_merge.for_the_non_predicate_version_"></a></span><a class="link" href="inplace_merge.html#range.reference.algorithms.mutating.inplace_merge.for_the_non_predicate_version_">For
123            the non-predicate version:</a>
124          </h6>
125<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
126<li class="listitem">
127                <code class="computeroutput"><span class="identifier">middle</span></code> is in the
128                range <code class="computeroutput"><span class="identifier">rng</span></code>.
129              </li>
130<li class="listitem">
131                <code class="computeroutput"><span class="special">[</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">middle</span><span class="special">)</span></code> is in ascending order. That is for
132                each pair of adjacent elements <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>,
133                <code class="computeroutput"><span class="identifier">y</span> <span class="special">&lt;</span>
134                <span class="identifier">x</span></code> is <code class="computeroutput"><span class="keyword">false</span></code>.
135              </li>
136<li class="listitem">
137                <code class="computeroutput"><span class="special">[</span><span class="identifier">middle</span><span class="special">,</span> <span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> is in ascending order. That is
138                for each pair of adjacent elements <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>,
139                <code class="computeroutput"><span class="identifier">y</span> <span class="special">&lt;</span>
140                <span class="identifier">x</span></code> is <code class="computeroutput"><span class="keyword">false</span></code>.
141              </li>
142</ul></div>
143<h6>
144<a name="range.reference.algorithms.mutating.inplace_merge.h6"></a>
145            <span class="phrase"><a name="range.reference.algorithms.mutating.inplace_merge.for_the_predicate_version_"></a></span><a class="link" href="inplace_merge.html#range.reference.algorithms.mutating.inplace_merge.for_the_predicate_version_">For
146            the predicate version:</a>
147          </h6>
148<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
149<li class="listitem">
150                <code class="computeroutput"><span class="identifier">middle</span></code> is in the
151                range <code class="computeroutput"><span class="identifier">rng</span></code>.
152              </li>
153<li class="listitem">
154                <code class="computeroutput"><span class="special">[</span><span class="identifier">begin</span><span class="special">(</span><span class="identifier">rng</span><span class="special">),</span> <span class="identifier">middle</span><span class="special">)</span></code> is in ascending order. That is for
155                each pair of adjacent elements <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>,
156                <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>.
157              </li>
158<li class="listitem">
159                <code class="computeroutput"><span class="special">[</span><span class="identifier">middle</span><span class="special">,</span> <span class="identifier">end</span><span class="special">(</span><span class="identifier">rng</span><span class="special">))</span></code> is in ascending order. That is
160                for each pair of adjacent elements <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>,
161                <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>.
162              </li>
163</ul></div>
164<h6>
165<a name="range.reference.algorithms.mutating.inplace_merge.h7"></a>
166            <span class="phrase"><a name="range.reference.algorithms.mutating.inplace_merge.complexity"></a></span><a class="link" href="inplace_merge.html#range.reference.algorithms.mutating.inplace_merge.complexity">Complexity</a>
167          </h6>
168<p>
169            Worst case: <code class="computeroutput"><span class="identifier">O</span><span class="special">(</span><span class="identifier">N</span> <span class="identifier">log</span><span class="special">(</span><span class="identifier">N</span><span class="special">))</span></code>
170          </p>
171</div>
172<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
173<td align="left"></td>
174<td align="right"><div class="copyright-footer">Copyright © 2003-2010 Thorsten Ottosen,
175      Neil Groves<p>
176        Distributed under the Boost Software License, Version 1.0. (See accompanying
177        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>)
178      </p>
179</div></td>
180</tr></table>
181<hr>
182<div class="spirit-nav">
183<a accesskey="p" href="generate.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="merge.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
184</div>
185</body>
186</html>
187