-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy path_min_heap_8h_source.html
202 lines (200 loc) · 23 KB
/
_min_heap_8h_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>STCP: C:/Users/isabe/OneDrive/Ambiente de Trabalho/FEUP/2_Ano/1_Semestre/AED/Projeto2/STCP/Src/MinHeap.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">STCP<span id="projectnumber"> 1.0.0</span>
</div>
<div id="projectbrief">Unidade Curricular AED</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_413f4e031a85da0d68269c6fd2f76e1c.html">Src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">MinHeap.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef STCP_MINHEAP_H</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define STCP_MINHEAP_H</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include <vector></span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include <unordered_map></span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#define LEFT(i) (2*(i))</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#define RIGHT(i) (2*(i)+1)</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#define PARENT(i) ((i)/2)</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="keyword">using namespace </span>std;</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment">// Binary min-heap to represent integer keys of type K with values (priorities) of type V</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="keyword">template</span> <<span class="keyword">class</span> K, <span class="keyword">class</span> V></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="class_min_heap.html"> 15</a></span><span class="keyword">class </span><a class="code hl_class" href="class_min_heap.html">MinHeap</a> {</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="struct_min_heap_1_1_node.html"> 16</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_min_heap_1_1_node.html">Node</a> { <span class="comment">// An element of the heap: a pair (key, value)</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> K key;</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> V value;</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> };</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <span class="keywordtype">int</span> size; <span class="comment">// Number of elements in heap</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <span class="keywordtype">int</span> maxSize; <span class="comment">// Maximum number of elements in heap</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> vector<Node> a; <span class="comment">// The heap array</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> unordered_map<K, int> pos; <span class="comment">// maps a key into its position on the array a</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">const</span> K KEY_NOT_FOUND;</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <span class="keywordtype">void</span> upHeap(<span class="keywordtype">int</span> i);</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keywordtype">void</span> downHeap(<span class="keywordtype">int</span> i);</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="keywordtype">void</span> swap(<span class="keywordtype">int</span> i1, <span class="keywordtype">int</span> i2);</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <a class="code hl_class" href="class_min_heap.html">MinHeap</a>(<span class="keywordtype">int</span> n, <span class="keyword">const</span> K& notFound); <span class="comment">// Create a min-heap for a max of n pairs (K,V) with notFound returned when empty</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keywordtype">int</span> getSize(); <span class="comment">// Return number of elements in the heap</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keywordtype">bool</span> hasKey(<span class="keyword">const</span> K& key) <span class="keyword">const</span>; <span class="comment">// Heap has key?</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keywordtype">void</span> insert(<span class="keyword">const</span> K& key, <span class="keyword">const</span> V& value); <span class="comment">// Insert (key, value) on the heap</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keywordtype">void</span> decreaseKey(<span class="keyword">const</span> K& key, <span class="keyword">const</span> V& value); <span class="comment">// Decrease value of key</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> K removeMin(); <span class="comment">// remove and return key with smaller value</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span>};</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="comment">// ----------------------------------------------</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="comment">// Make a value go "up the tree" until it reaches its position</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="keyword">template</span> <<span class="keyword">class</span> K, <span class="keyword">class</span> V></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="keywordtype">void</span> <a class="code hl_class" href="class_min_heap.html">MinHeap<K,V>::upHeap</a>(<span class="keywordtype">int</span> i) {</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keywordflow">while</span> (i>1 && a[i].value < a[PARENT(i)].value) { <span class="comment">// while pos smaller than parent, keep swapping to upper position</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> swap(i, PARENT(i));</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> i = PARENT(i);</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> }</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span>}</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="comment">// Make a value go "down the tree" until it reaches its position</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="keyword">template</span> <<span class="keyword">class</span> K, <span class="keyword">class</span> V></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="keywordtype">void</span> <a class="code hl_class" href="class_min_heap.html">MinHeap<K,V>::downHeap</a>(<span class="keywordtype">int</span> i) {</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="keywordflow">while</span> (LEFT(i) <= size) { <span class="comment">// while within heap limits</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keywordtype">int</span> j = LEFT(i);</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keywordflow">if</span> (RIGHT(i)<=size && a[RIGHT(i)].value < a[j].value) j = RIGHT(i); <span class="comment">// choose smaller child</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <span class="keywordflow">if</span> (a[i].value < a[j].value) <span class="keywordflow">break</span>; <span class="comment">// node already smaller than children, stop</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> swap(i, j); <span class="comment">// otherwise, swap with smaller child</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> i = j;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> }</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span>}</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="comment">// Swap two positions of the heap (update their positions)</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="keyword">template</span> <<span class="keyword">class</span> K, <span class="keyword">class</span> V></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="keywordtype">void</span> <a class="code hl_class" href="class_min_heap.html">MinHeap<K,V>::swap</a>(<span class="keywordtype">int</span> i1, <span class="keywordtype">int</span> i2) {</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> Node tmp = a[i1]; a[i1] = a[i2]; a[i2] = tmp;</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> pos[a[i1].key] = i1;</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> pos[a[i2].key] = i2;</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span>}</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span><span class="comment">// ----------------------------------------------</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span><span class="comment">// Create a min-heap for a max of n pairs (K,V) with notFound returned when empty</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span><span class="keyword">template</span> <<span class="keyword">class</span> K, <span class="keyword">class</span> V></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><a class="code hl_class" href="class_min_heap.html">MinHeap<K,V>::MinHeap</a>(<span class="keywordtype">int</span> n, <span class="keyword">const</span> K& notFound) : KEY_NOT_FOUND(notFound), size(0), maxSize(n), a(n+1) {</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span>}</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> </div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span><span class="comment">// Return number of elements in the heap</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span><span class="keyword">template</span> <<span class="keyword">class</span> K, <span class="keyword">class</span> V></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span><span class="keywordtype">int</span> <a class="code hl_class" href="class_min_heap.html">MinHeap<K,V>::getSize</a>() {</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <span class="keywordflow">return</span> size;</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span>}</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> </div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span><span class="comment">// Heap has key?</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><span class="keyword">template</span> <<span class="keyword">class</span> K, <span class="keyword">class</span> V></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span><span class="keywordtype">bool</span> <a class="code hl_class" href="class_min_heap.html">MinHeap<K, V>::hasKey</a>(<span class="keyword">const</span> K& key)<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <span class="keywordflow">return</span> pos.find(key) != pos.end();</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span>}</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> </div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><span class="comment">// Insert (key, value) on the heap</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span><span class="keyword">template</span> <<span class="keyword">class</span> K, <span class="keyword">class</span> V></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span><span class="keywordtype">void</span> <a class="code hl_class" href="class_min_heap.html">MinHeap<K,V>::insert</a>(<span class="keyword">const</span> K& key, <span class="keyword">const</span> V& value) {</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> <span class="keywordflow">if</span> (size == maxSize) <span class="keywordflow">return</span>; <span class="comment">// heap is full, do nothing</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> <span class="keywordflow">if</span> (hasKey(key)) <span class="keywordflow">return</span>; <span class="comment">// key already exists, do nothing</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> a[++size] = {key, value};</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> pos[key] = size;</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> upHeap(size);</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span>}</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> </div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span><span class="comment">// Decrease value of key to the indicated value</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span><span class="keyword">template</span> <<span class="keyword">class</span> K, <span class="keyword">class</span> V></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span><span class="keywordtype">void</span> <a class="code hl_class" href="class_min_heap.html">MinHeap<K,V>::decreaseKey</a>(<span class="keyword">const</span> K& key, <span class="keyword">const</span> V& value) {</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> <span class="keywordflow">if</span> (!hasKey(key)) <span class="keywordflow">return</span>; <span class="comment">// key does not exist, do nothing</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> <span class="keywordtype">int</span> i = pos[key];</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> <span class="keywordflow">if</span> (value > a[i].value) <span class="keywordflow">return</span>; <span class="comment">// value would increase, do nothing</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> a[i].value = value;</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> upHeap(i);</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span>}</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> </div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span><span class="comment">// remove and return key with smaller value</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span><span class="keyword">template</span> <<span class="keyword">class</span> K, <span class="keyword">class</span> V></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span>K <a class="code hl_class" href="class_min_heap.html">MinHeap<K,V>::removeMin</a>() {</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> <span class="keywordflow">if</span> (size == 0) <span class="keywordflow">return</span> KEY_NOT_FOUND;</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> K min = a[1].key;</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> pos.erase(min);</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> a[1] = a[size--];</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> downHeap(1);</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> <span class="keywordflow">return</span> min;</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span>}</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> </div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span><span class="preprocessor">#endif </span><span class="comment">//STCP_MINHEAP_H</span></div>
<div class="ttc" id="aclass_min_heap_html"><div class="ttname"><a href="class_min_heap.html">MinHeap</a></div><div class="ttdef"><b>Definition:</b> MinHeap.h:15</div></div>
<div class="ttc" id="astruct_min_heap_1_1_node_html"><div class="ttname"><a href="struct_min_heap_1_1_node.html">MinHeap::Node</a></div><div class="ttdef"><b>Definition:</b> MinHeap.h:16</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.2
</small></address>
</body>
</html>