• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>make_heap</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="../heap.html" title="Heap algorithms">
9<link rel="prev" href="pop_heap.html" title="pop_heap">
10<link rel="next" href="sort_heap.html" title="sort_heap">
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="pop_heap.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../heap.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="sort_heap.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.heap.make_heap"></a><a class="link" href="make_heap.html" title="make_heap">make_heap</a>
28</h5></div></div></div>
29<h6>
30<a name="range.reference.algorithms.heap.make_heap.h0"></a>
31            <span class="phrase"><a name="range.reference.algorithms.heap.make_heap.prototype"></a></span><a class="link" href="make_heap.html#range.reference.algorithms.heap.make_heap.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">RandomAccessRange</span><span class="special">&gt;</span>
36<span class="identifier">RandomAccessRange</span><span class="special">&amp;</span> <span class="identifier">make_heap</span><span class="special">(</span><span class="identifier">RandomAccessRange</span><span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">);</span>
37
38<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">&gt;</span>
39<span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&amp;</span> <span class="identifier">make_heap</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">);</span>
40
41<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Compare</span><span class="special">&gt;</span>
42<span class="identifier">RandomAccessRange</span><span class="special">&amp;</span> <span class="identifier">make_heap</span><span class="special">(</span><span class="identifier">RandomAccessRange</span><span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Compare</span> <span class="identifier">pred</span><span class="special">);</span>
43
44<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">RandomAccessRange</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">Compare</span><span class="special">&gt;</span>
45<span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&amp;</span> <span class="identifier">make_heap</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">RandomAccessRange</span><span class="special">&amp;</span> <span class="identifier">rng</span><span class="special">,</span> <span class="identifier">Compare</span> <span class="identifier">pred</span><span class="special">);</span>
46</pre>
47<p>
48          </p>
49<h6>
50<a name="range.reference.algorithms.heap.make_heap.h1"></a>
51            <span class="phrase"><a name="range.reference.algorithms.heap.make_heap.description"></a></span><a class="link" href="make_heap.html#range.reference.algorithms.heap.make_heap.description">Description</a>
52          </h6>
53<p>
54            <code class="computeroutput"><span class="identifier">make_heap</span></code> turns <code class="computeroutput"><span class="identifier">rng</span></code> into a heap.
55          </p>
56<p>
57            The ordering relationship is determined by using <code class="computeroutput"><span class="keyword">operator</span><span class="special">&lt;</span></code> in the non-predicate versions, and
58            by evaluating <code class="computeroutput"><span class="identifier">pred</span></code> in
59            the predicate versions.
60          </p>
61<h6>
62<a name="range.reference.algorithms.heap.make_heap.h2"></a>
63            <span class="phrase"><a name="range.reference.algorithms.heap.make_heap.definition"></a></span><a class="link" href="make_heap.html#range.reference.algorithms.heap.make_heap.definition">Definition</a>
64          </h6>
65<p>
66            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">heap_algorithm</span><span class="special">.</span><span class="identifier">hpp</span></code>
67          </p>
68<h6>
69<a name="range.reference.algorithms.heap.make_heap.h3"></a>
70            <span class="phrase"><a name="range.reference.algorithms.heap.make_heap.requirements"></a></span><a class="link" href="make_heap.html#range.reference.algorithms.heap.make_heap.requirements">Requirements</a>
71          </h6>
72<p>
73            <span class="bold"><strong>For the non-predicate versions:</strong></span>
74          </p>
75<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
76<li class="listitem">
77                <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>
78                is a model of the <a class="link" href="../../../concepts/random_access_range.html" title="Random Access Range">Random
79                Access Range</a> Concept.
80              </li>
81<li class="listitem">
82                <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>
83                is mutable.
84              </li>
85<li class="listitem">
86                <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>'s
87                value type is a model of the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>.
88              </li>
89<li class="listitem">
90                The ordering of objects of type <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>'s
91                value type is a <span class="bold"><strong><span class="emphasis"><em>strict weak ordering</em></span></strong></span>,
92                as defined in the <code class="computeroutput"><span class="identifier">LessThanComparableConcept</span></code>
93                requirements.
94              </li>
95</ul></div>
96<p>
97            <span class="bold"><strong>For the predicate versions:</strong></span>
98          </p>
99<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
100<li class="listitem">
101                <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>
102                is a model of the <a class="link" href="../../../concepts/random_access_range.html" title="Random Access Range">Random
103                Access Range</a> Concept.
104              </li>
105<li class="listitem">
106                <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>
107                is mutable.
108              </li>
109<li class="listitem">
110                <code class="computeroutput"><span class="identifier">Compare</span></code> is a model
111                of the <code class="computeroutput"><span class="identifier">StrictWeakOrderingConcept</span></code>.
112              </li>
113<li class="listitem">
114                <code class="computeroutput"><span class="identifier">RandomAccessRange</span></code>'s
115                value type is convertible to both of <code class="computeroutput"><span class="identifier">Compare</span></code>'s
116                argument types.
117              </li>
118</ul></div>
119<h6>
120<a name="range.reference.algorithms.heap.make_heap.h4"></a>
121            <span class="phrase"><a name="range.reference.algorithms.heap.make_heap.complexity"></a></span><a class="link" href="make_heap.html#range.reference.algorithms.heap.make_heap.complexity">Complexity</a>
122          </h6>
123<p>
124            Linear. At most <code class="computeroutput"><span class="number">3</span> <span class="special">*</span>
125            <span class="identifier">distance</span><span class="special">(</span><span class="identifier">rng</span><span class="special">)</span></code>
126            comparisons.
127          </p>
128</div>
129<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
130<td align="left"></td>
131<td align="right"><div class="copyright-footer">Copyright © 2003-2010 Thorsten Ottosen,
132      Neil Groves<p>
133        Distributed under the Boost Software License, Version 1.0. (See accompanying
134        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>)
135      </p>
136</div></td>
137</tr></table>
138<hr>
139<div class="spirit-nav">
140<a accesskey="p" href="pop_heap.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../heap.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="sort_heap.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
141</div>
142</body>
143</html>
144