js-stl
Version:
Standard TypeScript Library
2,052 lines • 40.5 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Queue - STL</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="shortcut icon" type="image/png" href="../assets/favicon.png">
<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="../..." title="STL"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.0.4</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/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>Queue Class</h1>
<div class="box meta">
<div class="extends">
Extends <a href="../classes/DoublyLinkedList.html" class="crosslink">DoublyLinkedList</a>
</div>
<div class="foundat">
Defined in: <a href="../files/Datastructures_Queue.ts.html#l4"><code>Datastructures/Queue.ts:4</code></a>
</div>
</div>
<div class="box intro">
<p>The Queue class provides the main functionality of a queue implemented using a doubly linked list.</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 inherited">
<a href="#method_add">add</a>
</li>
<li class="index-item method inherited">
<a href="#method_bottom">bottom</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">
<a href="#method_dequeue">dequeue</a>
</li>
<li class="index-item method">
<a href="#method_enqueue">enqueue</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_pop">pop</a>
</li>
<li class="index-item method inherited">
<a href="#method_prev">prev</a>
</li>
<li class="index-item method inherited">
<a href="#method_push">push</a>
</li>
<li class="index-item method inherited">
<a href="#method_rewind">rewind</a>
</li>
<li class="index-item method inherited">
<a href="#method_shift">shift</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_unshift">unshift</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__current">_current</a>
</li>
<li class="index-item property private inherited">
<a href="#property__head">_head</a>
</li>
<li class="index-item property private inherited">
<a href="#property__key">_key</a>
</li>
<li class="index-item property private inherited">
<a href="#property__length">_length</a>
</li>
<li class="index-item property private inherited">
<a href="#property__tail">_tail</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method_add" class="method item inherited">
<h3 class="name"><code>add</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>index</code>
</li>
<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/DoublyLinkedList.html#method_add">DoublyLinkedList</a>:
<a href="../files/Datastructures_DoublyLinkedList.ts.html#l53"><code>Datastructures/DoublyLinkedList.ts:53</code></a>
</p>
</div>
<div class="description">
<p>Insert a new value at the specified index</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">index</code>
<span class="type">Object</span>
<div class="param-description">
<p>The index where the new value is to be inserted.</p>
</div>
</li>
<li class="param">
<code class="param-name">value</code>
<span class="type">Object</span>
<div class="param-description">
<p>The new value for the index.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>void</p>
</div>
</div>
</div>
<div id="method_bottom" class="method item inherited">
<h3 class="name"><code>bottom</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/DoublyLinkedList.html#method_bottom">DoublyLinkedList</a>:
<a href="../files/Datastructures_DoublyLinkedList.ts.html#l173"><code>Datastructures/DoublyLinkedList.ts:173</code></a>
</p>
</div>
<div class="description">
<p>Peeks at the node from the beginning of the doubly linked list</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>any The value of the first node.</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/DoublyLinkedList.html#method_count">DoublyLinkedList</a>:
<a href="../files/Datastructures_DoublyLinkedList.ts.html#l183"><code>Datastructures/DoublyLinkedList.ts:183</code></a>
</p>
</div>
<div class="description">
<p>Counts the number of elements in the doubly linked list</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>number the number of elements in the doubly linked list.</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/DoublyLinkedList.html#method_current">DoublyLinkedList</a>:
<a href="../files/Datastructures_DoublyLinkedList.ts.html#l214"><code>Datastructures/DoublyLinkedList.ts:214</code></a>
</p>
</div>
<div class="description">
<p>Return current list entry</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_dequeue" class="method item">
<h3 class="name"><code>dequeue</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/Datastructures_Queue.ts.html#l23"><code>Datastructures/Queue.ts:23</code></a>
</p>
</div>
<div class="description">
<p>Dequeues a node from the queue</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>any The value of the dequeued node.</p>
</div>
</div>
</div>
<div id="method_enqueue" class="method item">
<h3 class="name"><code>enqueue</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>
Defined in
<a href="../files/Datastructures_Queue.ts.html#l12"><code>Datastructures/Queue.ts:12</code></a>
</p>
</div>
<div class="description">
<p>Adds an element to the queue</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 enqueue.</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/DoublyLinkedList.html#method_isEmpty">DoublyLinkedList</a>:
<a href="../files/Datastructures_DoublyLinkedList.ts.html#l193"><code>Datastructures/DoublyLinkedList.ts:193</code></a>
</p>
</div>
<div class="description">
<p>Checks whether the doubly linked list is empty</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>boolean whether the doubly linked list 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/DoublyLinkedList.html#method_key">DoublyLinkedList</a>:
<a href="../files/Datastructures_DoublyLinkedList.ts.html#l227"><code>Datastructures/DoublyLinkedList.ts:227</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/DoublyLinkedList.html#method_next">DoublyLinkedList</a>:
<a href="../files/Datastructures_DoublyLinkedList.ts.html#l237"><code>Datastructures/DoublyLinkedList.ts:237</code></a>
</p>
</div>
<div class="description">
<p>Move to next entry</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>void</p>
</div>
</div>
</div>
<div id="method_pop" class="method item inherited">
<h3 class="name"><code>pop</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/DoublyLinkedList.html#method_pop">DoublyLinkedList</a>:
<a href="../files/Datastructures_DoublyLinkedList.ts.html#l65"><code>Datastructures/DoublyLinkedList.ts:65</code></a>
</p>
</div>
<div class="description">
<p>Pops a node from the end of the doubly linked list</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>any The value of the popped node.</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/DoublyLinkedList.html#method_prev">DoublyLinkedList</a>:
<a href="../files/Datastructures_DoublyLinkedList.ts.html#l248"><code>Datastructures/DoublyLinkedList.ts:248</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_push" class="method item inherited">
<h3 class="name"><code>push</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/DoublyLinkedList.html#method_push">DoublyLinkedList</a>:
<a href="../files/Datastructures_DoublyLinkedList.ts.html#l113"><code>Datastructures/DoublyLinkedList.ts:113</code></a>
</p>
</div>
<div class="description">
<p>Pushes an element at the end of the doubly linked list</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 push.</p>
</div>
</li>
</ul>
</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/DoublyLinkedList.html#method_rewind">DoublyLinkedList</a>:
<a href="../files/Datastructures_DoublyLinkedList.ts.html#l203"><code>Datastructures/DoublyLinkedList.ts:203</code></a>
</p>
</div>
<div class="description">
<p>Rewind iterator back to the start</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>void</p>
</div>
</div>
</div>
<div id="method_shift" class="method item inherited">
<h3 class="name"><code>shift</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/DoublyLinkedList.html#method_shift">DoublyLinkedList</a>:
<a href="../files/Datastructures_DoublyLinkedList.ts.html#l89"><code>Datastructures/DoublyLinkedList.ts:89</code></a>
</p>
</div>
<div class="description">
<p>Shifts a node from the beginning of the doubly linked list</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>any The value of the shifted node.</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/DoublyLinkedList.html#method_toArray">DoublyLinkedList</a>:
<a href="../files/Datastructures_DoublyLinkedList.ts.html#l269"><code>Datastructures/DoublyLinkedList.ts:269</code></a>
</p>
</div>
<div class="description">
<p>Export the list to array</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>Array The exported 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/DoublyLinkedList.html#method_top">DoublyLinkedList</a>:
<a href="../files/Datastructures_DoublyLinkedList.ts.html#l163"><code>Datastructures/DoublyLinkedList.ts:163</code></a>
</p>
</div>
<div class="description">
<p>Peeks at the node from the end of the doubly linked list</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>any The value of the last node.</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/DoublyLinkedList.html#method_toString">DoublyLinkedList</a>:
<a href="../files/Datastructures_DoublyLinkedList.ts.html#l285"><code>Datastructures/DoublyLinkedList.ts:285</code></a>
</p>
</div>
<div class="description">
<p>Serializes the list 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_unshift" class="method item inherited">
<h3 class="name"><code>unshift</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/DoublyLinkedList.html#method_unshift">DoublyLinkedList</a>:
<a href="../files/Datastructures_DoublyLinkedList.ts.html#l138"><code>Datastructures/DoublyLinkedList.ts:138</code></a>
</p>
</div>
<div class="description">
<p>Prepends the doubly linked list with an element</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 unshift.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>void</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/DoublyLinkedList.html#method_valid">DoublyLinkedList</a>:
<a href="../files/Datastructures_DoublyLinkedList.ts.html#l259"><code>Datastructures/DoublyLinkedList.ts:259</code></a>
</p>
</div>
<div class="description">
<p>Check whether the doubly linked list contains more nodes</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<p>boolean true if the doubly linked list 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__current" class="property item private inherited">
<h3 class="name"><code>_current</code></h3>
<span class="type">DoublyLinkedListNode</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/DoublyLinkedList.html#property__current">DoublyLinkedList</a>:
<a href="../files/Datastructures_DoublyLinkedList.ts.html#l44"><code>Datastructures/DoublyLinkedList.ts:44</code></a>
</p>
</div>
<div class="description">
<p>Reference to iterated element in list</p>
</div>
</div>
<div id="property__head" class="property item private inherited">
<h3 class="name"><code>_head</code></h3>
<span class="type">DoublyLinkedListNode</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/DoublyLinkedList.html#property__head">DoublyLinkedList</a>:
<a href="../files/Datastructures_DoublyLinkedList.ts.html#l26"><code>Datastructures/DoublyLinkedList.ts:26</code></a>
</p>
</div>
<div class="description">
<p>Reference to head(first) element in list</p>
</div>
</div>
<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/DoublyLinkedList.html#property__key">DoublyLinkedList</a>:
<a href="../files/Datastructures_DoublyLinkedList.ts.html#l17"><code>Datastructures/DoublyLinkedList.ts:17</code></a>
</p>
</div>
<div class="description">
<p>Iteration pointer</p>
</div>
</div>
<div id="property__length" class="property item private inherited">
<h3 class="name"><code>_length</code></h3>
<span class="type">Number</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/DoublyLinkedList.html#property__length">DoublyLinkedList</a>:
<a href="../files/Datastructures_DoublyLinkedList.ts.html#l8"><code>Datastructures/DoublyLinkedList.ts:8</code></a>
</p>
</div>
<div class="description">
<p>Count of elements in list</p>
</div>
</div>
<div id="property__tail" class="property item private inherited">
<h3 class="name"><code>_tail</code></h3>
<span class="type">DoublyLinkedListNode</span>
<span class="flag private">private</span>
<div class="meta">
<p>Inherited from
<a href="../classes/DoublyLinkedList.html#property__tail">DoublyLinkedList</a>:
<a href="../files/Datastructures_DoublyLinkedList.ts.html#l35"><code>Datastructures/DoublyLinkedList.ts:35</code></a>
</p>
</div>
<div class="description">
<p>Reference to tail(last) element in list</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>