libstl
Version:
Standard JavaScript/TypeScript Library: DoublyLinkedList, Stack, Queue, Heap, MaxHeap, MinHeap, PriorityQueue
1,379 lines (837 loc) • 35.8 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>MaxHeap - libstl</title>
<link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
<link rel="icon" href="../assets/favicon.ico">
<script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
</head>
<body class="yui3-skin-sam">
<div id="doc">
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">
<h1><img src="https://vovazolotoy.github.io/docs/libstl.png" title="libstl"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.1.21</em>
</div>
</div>
<div id="bd" class="yui3-g">
<div class="yui3-u-1-4">
<div id="docs-sidebar" class="sidebar apidocs">
<div id="api-list">
<h2 class="off-left">APIs</h2>
<div id="api-tabview" class="tabview">
<ul class="tabs">
<li><a href="#api-classes">Classes</a></li>
<li><a href="#api-modules">Modules</a></li>
</ul>
<div id="api-tabview-filter">
<input type="search" id="api-filter" placeholder="Type to filter APIs">
</div>
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="../classes/DoublyLinkedList.html">DoublyLinkedList</a></li>
<li><a href="../classes/Heap.html">Heap</a></li>
<li><a href="../classes/MaxHeap.html">MaxHeap</a></li>
<li><a href="../classes/MinHeap.html">MinHeap</a></li>
<li><a href="../classes/PriorityQueue.html">PriorityQueue</a></li>
<li><a href="../classes/PriorityQueueNode.html">PriorityQueueNode</a></li>
<li><a href="../classes/Queue.html">Queue</a></li>
<li><a href="../classes/Stack.html">Stack</a></li>
</ul>
<ul id="api-modules" class="apis modules">
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="yui3-u-3-4">
<div id="api-options">
Show:
<label for="api-show-inherited">
<input type="checkbox" id="api-show-inherited" checked>
Inherited
</label>
<label for="api-show-protected">
<input type="checkbox" id="api-show-protected">
Protected
</label>
<label for="api-show-private">
<input type="checkbox" id="api-show-private">
Private
</label>
<label for="api-show-deprecated">
<input type="checkbox" id="api-show-deprecated">
Deprecated
</label>
</div>
<div class="apidocs">
<div id="docs-main">
<div class="content">
<h1>MaxHeap Class</h1>
<div class="box meta">
<div class="extends">
Extends <a href="../classes/Heap.html" class="crosslink">Heap</a>
</div>
<div class="foundat">
Defined in: <a href="../files/Datastructures_MaxHeap.ts.html#l4"><code>Datastructures/MaxHeap.ts:4</code></a>
</div>
</div>
<div class="box intro">
<p>The MaxHeap class provides the main functionality of a heap, keeping the maximum on the top.</p>
</div>
<div id="classdocs" class="tabview">
<ul class="api-class-tabs">
<li class="api-class-tab index"><a href="#index">Index</a></li>
<li class="api-class-tab methods"><a href="#methods">Methods</a></li>
<li class="api-class-tab properties"><a href="#properties">Properties</a></li>
</ul>
<div>
<div id="index" class="api-class-tabpanel index">
<h2 class="off-left">Item Index</h2>
<div class="index-section methods">
<h3>Methods</h3>
<ul class="index-list methods extends">
<li class="index-item method private inherited">
<a href="#method__child">_child</a>
</li>
<li class="index-item method private inherited">
<a href="#method__displayNode">_displayNode</a>
</li>
<li class="index-item method private inherited">
<a href="#method__parent">_parent</a>
</li>
<li class="index-item method private inherited">
<a href="#method__siftDown">_siftDown</a>
</li>
<li class="index-item method private inherited">
<a href="#method__siftUp">_siftUp</a>
</li>
<li class="index-item method private inherited">
<a href="#method__swap">_swap</a>
</li>
<li class="index-item method inherited">
<a href="#method_compare">compare</a>
</li>
<li class="index-item method inherited">
<a href="#method_count">count</a>
</li>
<li class="index-item method inherited">
<a href="#method_current">current</a>
</li>
<li class="index-item method inherited">
<a href="#method_extract">extract</a>
</li>
<li class="index-item method inherited">
<a href="#method_insert">insert</a>
</li>
<li class="index-item method inherited">
<a href="#method_isEmpty">isEmpty</a>
</li>
<li class="index-item method inherited">
<a href="#method_key">key</a>
</li>
<li class="index-item method inherited">
<a href="#method_next">next</a>
</li>
<li class="index-item method inherited">
<a href="#method_prev">prev</a>
</li>
<li class="index-item method inherited">
<a href="#method_rewind">rewind</a>
</li>
<li class="index-item method inherited">
<a href="#method_toArray">toArray</a>
</li>
<li class="index-item method inherited">
<a href="#method_top">top</a>
</li>
<li class="index-item method inherited">
<a href="#method_toString">toString</a>
</li>
<li class="index-item method inherited">
<a href="#method_valid">valid</a>
</li>
</ul>
</div>
<div class="index-section properties">
<h3>Properties</h3>
<ul class="index-list properties extends">
<li class="index-item property private inherited">
<a href="#property__key">_key</a>
</li>
<li class="index-item property private inherited">
<a href="#property__tree">_tree</a>
</li>
<li class="index-item property private inherited">
<a href="#property__type">_type</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method__child" class="method item private inherited">
<h3 class="name"><code>_child</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>n</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"></span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Heap.html#method__child">Heap</a>:
<a href="../files/Datastructures_Heap.ts.html#l53"><code>Datastructures/Heap.ts:53</code></a>
</p>
</div>
<div class="description">
<p>Get index of left child element in binary tree stored in array</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">n</code>
<span class="type">Object</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>number</p>
</div>
</div>
</div>
<div id="method__displayNode" class="method item private inherited">
<h3 class="name"><code>_displayNode</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>node</code>
</li>
<li class="arg">
<code>prefix</code>
</li>
<li class="arg">
<code>last</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"></span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Heap.html#method__displayNode">Heap</a>:
<a href="../files/Datastructures_Heap.ts.html#l294"><code>Datastructures/Heap.ts:294</code></a>
</p>
</div>
<div class="description">
<p>Visually display heap tree</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">node</code>
<span class="type">Object</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">prefix</code>
<span class="type">Object</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">last</code>
<span class="type">Object</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>String</p>
</div>
</div>
</div>
<div id="method__parent" class="method item private inherited">
<h3 class="name"><code>_parent</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>n</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"></span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Heap.html#method__parent">Heap</a>:
<a href="../files/Datastructures_Heap.ts.html#l65"><code>Datastructures/Heap.ts:65</code></a>
</p>
</div>
<div class="description">
<p>Get index of parent element in binary tree stored in array</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">n</code>
<span class="type">Object</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>number</p>
</div>
</div>
</div>
<div id="method__siftDown" class="method item private inherited">
<h3 class="name"><code>_siftDown</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>i</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Heap.html#method__siftDown">Heap</a>:
<a href="../files/Datastructures_Heap.ts.html#l110"><code>Datastructures/Heap.ts:110</code></a>
</p>
</div>
<div class="description">
<p>Sift down elements in binary tree</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">i</code>
<span class="type">Object</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="method__siftUp" class="method item private inherited">
<h3 class="name"><code>_siftUp</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>i</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Heap.html#method__siftUp">Heap</a>:
<a href="../files/Datastructures_Heap.ts.html#l91"><code>Datastructures/Heap.ts:91</code></a>
</p>
</div>
<div class="description">
<p>Sift elements in binary tree</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">i</code>
<span class="type">Object</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="method__swap" class="method item private inherited">
<h3 class="name"><code>_swap</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>first</code>
</li>
<li class="arg">
<code>second</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Heap.html#method__swap">Heap</a>:
<a href="../files/Datastructures_Heap.ts.html#l77"><code>Datastructures/Heap.ts:77</code></a>
</p>
</div>
<div class="description">
<p>Swap 2 elements in binary tree</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">first</code>
<span class="type">Object</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">second</code>
<span class="type">Object</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="method_compare" class="method item inherited">
<h3 class="name"><code>compare</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>first</code>
</li>
<li class="arg">
<code>second</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Heap.html#method_compare">Heap</a>:
<a href="../files/Datastructures_Heap.ts.html#l275"><code>Datastructures/Heap.ts:275</code></a>
</p>
</div>
<div class="description">
<p>Compare elements in order to place them correctly in the heap while sifting up.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">first</code>
<span class="type">Object</span>
<div class="param-description">
<p>The value of the first node being compared.</p>
</div>
</li>
<li class="param">
<code class="param-name">second</code>
<span class="type">Object</span>
<div class="param-description">
<p>The value of the second node being compared.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>number Result of the comparison, positive integer if first is greater than second, 0 if they are equal, negative integer otherwise.
Having multiple elements with the same value in a Heap is not recommended. They will end up in an arbitrary relative position.</p>
</div>
</div>
</div>
<div id="method_count" class="method item inherited">
<h3 class="name"><code>count</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Heap.html#method_count">Heap</a>:
<a href="../files/Datastructures_Heap.ts.html#l195"><code>Datastructures/Heap.ts:195</code></a>
</p>
</div>
<div class="description">
<p>Counts the number of elements in the heap</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>number the number of elements in the heap.</p>
</div>
</div>
</div>
<div id="method_current" class="method item inherited">
<h3 class="name"><code>current</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Heap.html#method_current">Heap</a>:
<a href="../files/Datastructures_Heap.ts.html#l225"><code>Datastructures/Heap.ts:225</code></a>
</p>
</div>
<div class="description">
<p>Return current node pointed by the iterator</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>any The current node value.</p>
</div>
</div>
</div>
<div id="method_extract" class="method item inherited">
<h3 class="name"><code>extract</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Heap.html#method_extract">Heap</a>:
<a href="../files/Datastructures_Heap.ts.html#l146"><code>Datastructures/Heap.ts:146</code></a>
</p>
</div>
<div class="description">
<p>Extracts a node from top of the heap and sift up</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>any The value of the extracted node.</p>
</div>
</div>
</div>
<div id="method_insert" class="method item inherited">
<h3 class="name"><code>insert</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>value</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Heap.html#method_insert">Heap</a>:
<a href="../files/Datastructures_Heap.ts.html#l169"><code>Datastructures/Heap.ts:169</code></a>
</p>
</div>
<div class="description">
<p>Inserts an element in the heap by sifting it up</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">value</code>
<span class="type">Object</span>
<div class="param-description">
<p>The value to insert.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>void</p>
</div>
</div>
</div>
<div id="method_isEmpty" class="method item inherited">
<h3 class="name"><code>isEmpty</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Heap.html#method_isEmpty">Heap</a>:
<a href="../files/Datastructures_Heap.ts.html#l205"><code>Datastructures/Heap.ts:205</code></a>
</p>
</div>
<div class="description">
<p>Checks whether the heap is empty</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>boolean whether the heap is empty.</p>
</div>
</div>
</div>
<div id="method_key" class="method item inherited">
<h3 class="name"><code>key</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Heap.html#method_key">Heap</a>:
<a href="../files/Datastructures_Heap.ts.html#l235"><code>Datastructures/Heap.ts:235</code></a>
</p>
</div>
<div class="description">
<p>Return current node index</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>any The current node index.</p>
</div>
</div>
</div>
<div id="method_next" class="method item inherited">
<h3 class="name"><code>next</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Heap.html#method_next">Heap</a>:
<a href="../files/Datastructures_Heap.ts.html#l245"><code>Datastructures/Heap.ts:245</code></a>
</p>
</div>
<div class="description">
<p>Move to the next node</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>void</p>
</div>
</div>
</div>
<div id="method_prev" class="method item inherited">
<h3 class="name"><code>prev</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Heap.html#method_prev">Heap</a>:
<a href="../files/Datastructures_Heap.ts.html#l255"><code>Datastructures/Heap.ts:255</code></a>
</p>
</div>
<div class="description">
<p>Move to previous entry</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>void</p>
</div>
</div>
</div>
<div id="method_rewind" class="method item inherited">
<h3 class="name"><code>rewind</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Heap.html#method_rewind">Heap</a>:
<a href="../files/Datastructures_Heap.ts.html#l215"><code>Datastructures/Heap.ts:215</code></a>
</p>
</div>
<div class="description">
<p>Rewind iterator back to the start (no-op)</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>void</p>
</div>
</div>
</div>
<div id="method_toArray" class="method item inherited">
<h3 class="name"><code>toArray</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Heap.html#method_toArray">Heap</a>:
<a href="../files/Datastructures_Heap.ts.html#l343"><code>Datastructures/Heap.ts:343</code></a>
</p>
</div>
<div class="description">
<p>Serializes the heap to array</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>Array The serialized array.</p>
</div>
</div>
</div>
<div id="method_top" class="method item inherited">
<h3 class="name"><code>top</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Heap.html#method_top">Heap</a>:
<a href="../files/Datastructures_Heap.ts.html#l181"><code>Datastructures/Heap.ts:181</code></a>
</p>
</div>
<div class="description">
<p>Peeks at the node from the top of the heap</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>any The value of the node on the top.</p>
</div>
</div>
</div>
<div id="method_toString" class="method item inherited">
<h3 class="name"><code>toString</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Heap.html#method_toString">Heap</a>:
<a href="../files/Datastructures_Heap.ts.html#l332"><code>Datastructures/Heap.ts:332</code></a>
</p>
</div>
<div class="description">
<p>Serializes the heap to string</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>string The serialized string.</p>
</div>
</div>
</div>
<div id="method_valid" class="method item inherited">
<h3 class="name"><code>valid</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Heap.html#method_valid">Heap</a>:
<a href="../files/Datastructures_Heap.ts.html#l265"><code>Datastructures/Heap.ts:265</code></a>
</p>
</div>
<div class="description">
<p>Check whether the heap contains more nodes</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>boolean true if the heap contains any more nodes, false otherwise.</p>
</div>
</div>
</div>
</div>
<div id="properties" class="api-class-tabpanel">
<h2 class="off-left">Properties</h2>
<div id="property__key" class="property item private inherited">
<h3 class="name"><code>_key</code></h3>
<span class="type">Number</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Heap.html#property__key">Heap</a>:
<a href="../files/Datastructures_Heap.ts.html#l44"><code>Datastructures/Heap.ts:44</code></a>
</p>
</div>
<div class="description">
<p>Iteration pointer</p>
</div>
</div>
<div id="property__tree" class="property item private inherited">
<h3 class="name"><code>_tree</code></h3>
<span class="type">Array</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Heap.html#property__tree">Heap</a>:
<a href="../files/Datastructures_Heap.ts.html#l26"><code>Datastructures/Heap.ts:26</code></a>
</p>
</div>
<div class="description">
<p>Binary tree storage array</p>
</div>
</div>
<div id="property__type" class="property item private inherited">
<h3 class="name"><code>_type</code></h3>
<span class="type">Number</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/Heap.html#property__type">Heap</a>:
<a href="../files/Datastructures_Heap.ts.html#l35"><code>Datastructures/Heap.ts:35</code></a>
</p>
</div>
<div class="description">
<p>Heap type</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../assets/../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>