source: javadoc/genius/core/misc/Queue.html@ 1

Last change on this file since 1 was 1, checked in by Wouter Pasman, 7 years ago

Initial import : Genius 9.0.0

File size: 13.2 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!-- NewPage -->
3<html lang="en">
4<head>
5<!-- Generated by javadoc (1.8.0_112) on Thu Jun 21 12:05:57 CEST 2018 -->
6<title>Queue (Genius Core Documentation)</title>
7<meta name="date" content="2018-06-21">
8<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
9<script type="text/javascript" src="../../../script.js"></script>
10</head>
11<body>
12<script type="text/javascript"><!--
13 try {
14 if (location.href.indexOf('is-external=true') == -1) {
15 parent.document.title="Queue (Genius Core Documentation)";
16 }
17 }
18 catch(err) {
19 }
20//-->
21var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
22var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
23var altColor = "altColor";
24var rowColor = "rowColor";
25var tableTab = "tableTab";
26var activeTableTab = "activeTableTab";
27</script>
28<noscript>
29<div>JavaScript is disabled on your browser.</div>
30</noscript>
31<!-- ========= START OF TOP NAVBAR ======= -->
32<div class="topNav"><a name="navbar.top">
33<!-- -->
34</a>
35<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
36<a name="navbar.top.firstrow">
37<!-- -->
38</a>
39<ul class="navList" title="Navigation">
40<li><a href="../../../overview-summary.html">Overview</a></li>
41<li><a href="package-summary.html">Package</a></li>
42<li class="navBarCell1Rev">Class</li>
43<li><a href="class-use/Queue.html">Use</a></li>
44<li><a href="package-tree.html">Tree</a></li>
45<li><a href="../../../deprecated-list.html">Deprecated</a></li>
46<li><a href="../../../index-all.html">Index</a></li>
47<li><a href="../../../help-doc.html">Help</a></li>
48</ul>
49</div>
50<div class="subNav">
51<ul class="navList">
52<li><a href="../../../genius/core/misc/Progress.html" title="class in genius.core.misc"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
53<li><a href="../../../genius/core/misc/Range.html" title="class in genius.core.misc"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
54</ul>
55<ul class="navList">
56<li><a href="../../../index.html?genius/core/misc/Queue.html" target="_top">Frames</a></li>
57<li><a href="Queue.html" target="_top">No&nbsp;Frames</a></li>
58</ul>
59<ul class="navList" id="allclasses_navbar_top">
60<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
61</ul>
62<div>
63<script type="text/javascript"><!--
64 allClassesLink = document.getElementById("allclasses_navbar_top");
65 if(window==top) {
66 allClassesLink.style.display = "block";
67 }
68 else {
69 allClassesLink.style.display = "none";
70 }
71 //-->
72</script>
73</div>
74<div>
75<ul class="subNavList">
76<li>Summary:&nbsp;</li>
77<li>Nested&nbsp;|&nbsp;</li>
78<li>Field&nbsp;|&nbsp;</li>
79<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
80<li><a href="#method.summary">Method</a></li>
81</ul>
82<ul class="subNavList">
83<li>Detail:&nbsp;</li>
84<li>Field&nbsp;|&nbsp;</li>
85<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
86<li><a href="#method.detail">Method</a></li>
87</ul>
88</div>
89<a name="skip.navbar.top">
90<!-- -->
91</a></div>
92<!-- ========= END OF TOP NAVBAR ========= -->
93<!-- ======== START OF CLASS DATA ======== -->
94<div class="header">
95<div class="subTitle">genius.core.misc</div>
96<h2 title="Class Queue" class="title">Class Queue</h2>
97</div>
98<div class="contentContainer">
99<ul class="inheritance">
100<li>java.lang.Object</li>
101<li>
102<ul class="inheritance">
103<li>genius.core.misc.Queue</li>
104</ul>
105</li>
106</ul>
107<div class="description">
108<ul class="blockList">
109<li class="blockList">
110<hr>
111<br>
112<pre>public class <span class="typeNameLabel">Queue</span>
113extends java.lang.Object</pre>
114<div class="block">Array-based implementation of the queue.</div>
115<dl>
116<dt><span class="simpleTagLabel">Author:</span></dt>
117<dd>Mark Allen Weiss</dd>
118</dl>
119</li>
120</ul>
121</div>
122<div class="summary">
123<ul class="blockList">
124<li class="blockList">
125<!-- ======== CONSTRUCTOR SUMMARY ======== -->
126<ul class="blockList">
127<li class="blockList"><a name="constructor.summary">
128<!-- -->
129</a>
130<h3>Constructor Summary</h3>
131<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
132<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
133<tr>
134<th class="colOne" scope="col">Constructor and Description</th>
135</tr>
136<tr class="altColor">
137<td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/misc/Queue.html#Queue--">Queue</a></span>()</code>
138<div class="block">Construct the queue.</div>
139</td>
140</tr>
141<tr class="rowColor">
142<td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/misc/Queue.html#Queue-int-">Queue</a></span>(int&nbsp;size)</code>
143<div class="block">Construct the queue.</div>
144</td>
145</tr>
146</table>
147</li>
148</ul>
149<!-- ========== METHOD SUMMARY =========== -->
150<ul class="blockList">
151<li class="blockList"><a name="method.summary">
152<!-- -->
153</a>
154<h3>Method Summary</h3>
155<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
156<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
157<tr>
158<th class="colFirst" scope="col">Modifier and Type</th>
159<th class="colLast" scope="col">Method and Description</th>
160</tr>
161<tr id="i0" class="altColor">
162<td class="colFirst"><code>java.lang.Double</code></td>
163<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/misc/Queue.html#dequeue--">dequeue</a></span>()</code>
164<div class="block">Return and remove the least recently inserted item
165 from the queue.</div>
166</td>
167</tr>
168<tr id="i1" class="rowColor">
169<td class="colFirst"><code>void</code></td>
170<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/misc/Queue.html#enqueue-java.lang.Double-">enqueue</a></span>(java.lang.Double&nbsp;x)</code>
171<div class="block">Insert a new item into the queue.</div>
172</td>
173</tr>
174<tr id="i2" class="altColor">
175<td class="colFirst"><code>java.lang.Double</code></td>
176<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/misc/Queue.html#getFront--">getFront</a></span>()</code>
177<div class="block">Get the least recently inserted item in the queue.</div>
178</td>
179</tr>
180<tr id="i3" class="rowColor">
181<td class="colFirst"><code>boolean</code></td>
182<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/misc/Queue.html#isEmpty--">isEmpty</a></span>()</code>
183<div class="block">Test if the queue is logically empty.</div>
184</td>
185</tr>
186<tr id="i4" class="altColor">
187<td class="colFirst"><code>void</code></td>
188<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/misc/Queue.html#makeEmpty--">makeEmpty</a></span>()</code>
189<div class="block">Make the queue logically empty.</div>
190</td>
191</tr>
192<tr id="i5" class="rowColor">
193<td class="colFirst"><code>int</code></td>
194<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/misc/Queue.html#size--">size</a></span>()</code>&nbsp;</td>
195</tr>
196<tr id="i6" class="altColor">
197<td class="colFirst"><code>java.lang.Double[]</code></td>
198<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/misc/Queue.html#toArray--">toArray</a></span>()</code>&nbsp;</td>
199</tr>
200</table>
201<ul class="blockList">
202<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
203<!-- -->
204</a>
205<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
206<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
207</ul>
208</li>
209</ul>
210</li>
211</ul>
212</div>
213<div class="details">
214<ul class="blockList">
215<li class="blockList">
216<!-- ========= CONSTRUCTOR DETAIL ======== -->
217<ul class="blockList">
218<li class="blockList"><a name="constructor.detail">
219<!-- -->
220</a>
221<h3>Constructor Detail</h3>
222<a name="Queue--">
223<!-- -->
224</a>
225<ul class="blockList">
226<li class="blockList">
227<h4>Queue</h4>
228<pre>public&nbsp;Queue()</pre>
229<div class="block">Construct the queue.</div>
230</li>
231</ul>
232<a name="Queue-int-">
233<!-- -->
234</a>
235<ul class="blockListLast">
236<li class="blockList">
237<h4>Queue</h4>
238<pre>public&nbsp;Queue(int&nbsp;size)</pre>
239<div class="block">Construct the queue.</div>
240<dl>
241<dt><span class="paramLabel">Parameters:</span></dt>
242<dd><code>size</code> - of the queue.</dd>
243</dl>
244</li>
245</ul>
246</li>
247</ul>
248<!-- ============ METHOD DETAIL ========== -->
249<ul class="blockList">
250<li class="blockList"><a name="method.detail">
251<!-- -->
252</a>
253<h3>Method Detail</h3>
254<a name="isEmpty--">
255<!-- -->
256</a>
257<ul class="blockList">
258<li class="blockList">
259<h4>isEmpty</h4>
260<pre>public&nbsp;boolean&nbsp;isEmpty()</pre>
261<div class="block">Test if the queue is logically empty.</div>
262<dl>
263<dt><span class="returnLabel">Returns:</span></dt>
264<dd>true if empty, false otherwise.</dd>
265</dl>
266</li>
267</ul>
268<a name="makeEmpty--">
269<!-- -->
270</a>
271<ul class="blockList">
272<li class="blockList">
273<h4>makeEmpty</h4>
274<pre>public&nbsp;void&nbsp;makeEmpty()</pre>
275<div class="block">Make the queue logically empty.</div>
276</li>
277</ul>
278<a name="dequeue--">
279<!-- -->
280</a>
281<ul class="blockList">
282<li class="blockList">
283<h4>dequeue</h4>
284<pre>public&nbsp;java.lang.Double&nbsp;dequeue()</pre>
285<div class="block">Return and remove the least recently inserted item
286 from the queue.</div>
287<dl>
288<dt><span class="returnLabel">Returns:</span></dt>
289<dd>the least recently inserted item in the queue.</dd>
290</dl>
291</li>
292</ul>
293<a name="getFront--">
294<!-- -->
295</a>
296<ul class="blockList">
297<li class="blockList">
298<h4>getFront</h4>
299<pre>public&nbsp;java.lang.Double&nbsp;getFront()</pre>
300<div class="block">Get the least recently inserted item in the queue.
301 Does not alter the queue.</div>
302<dl>
303<dt><span class="returnLabel">Returns:</span></dt>
304<dd>the least recently inserted item in the queue.</dd>
305</dl>
306</li>
307</ul>
308<a name="enqueue-java.lang.Double-">
309<!-- -->
310</a>
311<ul class="blockList">
312<li class="blockList">
313<h4>enqueue</h4>
314<pre>public&nbsp;void&nbsp;enqueue(java.lang.Double&nbsp;x)</pre>
315<div class="block">Insert a new item into the queue.</div>
316<dl>
317<dt><span class="paramLabel">Parameters:</span></dt>
318<dd><code>x</code> - the item to insert.</dd>
319</dl>
320</li>
321</ul>
322<a name="size--">
323<!-- -->
324</a>
325<ul class="blockList">
326<li class="blockList">
327<h4>size</h4>
328<pre>public&nbsp;int&nbsp;size()</pre>
329<dl>
330<dt><span class="returnLabel">Returns:</span></dt>
331<dd>amount of elements in the queue.</dd>
332</dl>
333</li>
334</ul>
335<a name="toArray--">
336<!-- -->
337</a>
338<ul class="blockListLast">
339<li class="blockList">
340<h4>toArray</h4>
341<pre>public&nbsp;java.lang.Double[]&nbsp;toArray()</pre>
342<dl>
343<dt><span class="returnLabel">Returns:</span></dt>
344<dd>array of queue (watch out, contains empty cells)</dd>
345</dl>
346</li>
347</ul>
348</li>
349</ul>
350</li>
351</ul>
352</div>
353</div>
354<!-- ========= END OF CLASS DATA ========= -->
355<!-- ======= START OF BOTTOM NAVBAR ====== -->
356<div class="bottomNav"><a name="navbar.bottom">
357<!-- -->
358</a>
359<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
360<a name="navbar.bottom.firstrow">
361<!-- -->
362</a>
363<ul class="navList" title="Navigation">
364<li><a href="../../../overview-summary.html">Overview</a></li>
365<li><a href="package-summary.html">Package</a></li>
366<li class="navBarCell1Rev">Class</li>
367<li><a href="class-use/Queue.html">Use</a></li>
368<li><a href="package-tree.html">Tree</a></li>
369<li><a href="../../../deprecated-list.html">Deprecated</a></li>
370<li><a href="../../../index-all.html">Index</a></li>
371<li><a href="../../../help-doc.html">Help</a></li>
372</ul>
373</div>
374<div class="subNav">
375<ul class="navList">
376<li><a href="../../../genius/core/misc/Progress.html" title="class in genius.core.misc"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
377<li><a href="../../../genius/core/misc/Range.html" title="class in genius.core.misc"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
378</ul>
379<ul class="navList">
380<li><a href="../../../index.html?genius/core/misc/Queue.html" target="_top">Frames</a></li>
381<li><a href="Queue.html" target="_top">No&nbsp;Frames</a></li>
382</ul>
383<ul class="navList" id="allclasses_navbar_bottom">
384<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
385</ul>
386<div>
387<script type="text/javascript"><!--
388 allClassesLink = document.getElementById("allclasses_navbar_bottom");
389 if(window==top) {
390 allClassesLink.style.display = "block";
391 }
392 else {
393 allClassesLink.style.display = "none";
394 }
395 //-->
396</script>
397</div>
398<div>
399<ul class="subNavList">
400<li>Summary:&nbsp;</li>
401<li>Nested&nbsp;|&nbsp;</li>
402<li>Field&nbsp;|&nbsp;</li>
403<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
404<li><a href="#method.summary">Method</a></li>
405</ul>
406<ul class="subNavList">
407<li>Detail:&nbsp;</li>
408<li>Field&nbsp;|&nbsp;</li>
409<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
410<li><a href="#method.detail">Method</a></li>
411</ul>
412</div>
413<a name="skip.navbar.bottom">
414<!-- -->
415</a></div>
416<!-- ======== END OF BOTTOM NAVBAR ======= -->
417</body>
418</html>
Note: See TracBrowser for help on using the repository browser.