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