source: javadoc/genius/core/misc/Pair.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: 14.7 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>Pair (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="Pair (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/Pair.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/FileTools.html" title="class in genius.core.misc"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
53<li><a href="../../../genius/core/misc/Progress.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/Pair.html" target="_top">Frames</a></li>
57<li><a href="Pair.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 Pair" class="title">Class Pair&lt;A,B&gt;</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.Pair&lt;A,B&gt;</li>
104</ul>
105</li>
106</ul>
107<div class="description">
108<ul class="blockList">
109<li class="blockList">
110<dl>
111<dt><span class="paramLabel">Type Parameters:</span></dt>
112<dd><code>A</code> - class of the first object.</dd>
113<dd><code>B</code> - class of the second object.</dd>
114</dl>
115<dl>
116<dt>All Implemented Interfaces:</dt>
117<dd>java.io.Serializable</dd>
118</dl>
119<hr>
120<br>
121<pre>public class <span class="typeNameLabel">Pair&lt;A,B&gt;</span>
122extends java.lang.Object
123implements java.io.Serializable</pre>
124<div class="block">A simple tuple class.</div>
125<dl>
126<dt><span class="simpleTagLabel">Author:</span></dt>
127<dd>Alex Dirkzwager, Mark Hendrikx, Julian de Ruiter</dd>
128<dt><span class="seeLabel">See Also:</span></dt>
129<dd><a href="../../../serialized-form.html#genius.core.misc.Pair">Serialized Form</a></dd>
130</dl>
131</li>
132</ul>
133</div>
134<div class="summary">
135<ul class="blockList">
136<li class="blockList">
137<!-- ======== CONSTRUCTOR SUMMARY ======== -->
138<ul class="blockList">
139<li class="blockList"><a name="constructor.summary">
140<!-- -->
141</a>
142<h3>Constructor Summary</h3>
143<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
144<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
145<tr>
146<th class="colOne" scope="col">Constructor and Description</th>
147</tr>
148<tr class="altColor">
149<td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/misc/Pair.html#Pair-A-B-">Pair</a></span>(<a href="../../../genius/core/misc/Pair.html" title="type parameter in Pair">A</a>&nbsp;fst,
150 <a href="../../../genius/core/misc/Pair.html" title="type parameter in Pair">B</a>&nbsp;snd)</code>
151<div class="block">Create a pair from the given two objects.</div>
152</td>
153</tr>
154</table>
155</li>
156</ul>
157<!-- ========== METHOD SUMMARY =========== -->
158<ul class="blockList">
159<li class="blockList"><a name="method.summary">
160<!-- -->
161</a>
162<h3>Method Summary</h3>
163<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
164<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>
165<tr>
166<th class="colFirst" scope="col">Modifier and Type</th>
167<th class="colLast" scope="col">Method and Description</th>
168</tr>
169<tr id="i0" class="altColor">
170<td class="colFirst"><code>boolean</code></td>
171<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/misc/Pair.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;other)</code>&nbsp;</td>
172</tr>
173<tr id="i1" class="rowColor">
174<td class="colFirst"><code><a href="../../../genius/core/misc/Pair.html" title="type parameter in Pair">A</a></code></td>
175<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/misc/Pair.html#getFirst--">getFirst</a></span>()</code>
176<div class="block">Return the first object of the pair.</div>
177</td>
178</tr>
179<tr id="i2" class="altColor">
180<td class="colFirst"><code><a href="../../../genius/core/misc/Pair.html" title="type parameter in Pair">B</a></code></td>
181<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/misc/Pair.html#getSecond--">getSecond</a></span>()</code>
182<div class="block">Return the second object of the pair.</div>
183</td>
184</tr>
185<tr id="i3" class="rowColor">
186<td class="colFirst"><code>int</code></td>
187<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/misc/Pair.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
188</tr>
189<tr id="i4" class="altColor">
190<td class="colFirst"><code>void</code></td>
191<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/misc/Pair.html#setFirst-A-">setFirst</a></span>(<a href="../../../genius/core/misc/Pair.html" title="type parameter in Pair">A</a>&nbsp;v)</code>
192<div class="block">Set the first object of the pair.</div>
193</td>
194</tr>
195<tr id="i5" class="rowColor">
196<td class="colFirst"><code>void</code></td>
197<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/misc/Pair.html#setSecond-B-">setSecond</a></span>(<a href="../../../genius/core/misc/Pair.html" title="type parameter in Pair">B</a>&nbsp;v)</code>
198<div class="block">Set the second object of the pair.</div>
199</td>
200</tr>
201<tr id="i6" class="altColor">
202<td class="colFirst"><code>java.lang.String</code></td>
203<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/misc/Pair.html#toString--">toString</a></span>()</code>&nbsp;</td>
204</tr>
205</table>
206<ul class="blockList">
207<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
208<!-- -->
209</a>
210<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
211<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
212</ul>
213</li>
214</ul>
215</li>
216</ul>
217</div>
218<div class="details">
219<ul class="blockList">
220<li class="blockList">
221<!-- ========= CONSTRUCTOR DETAIL ======== -->
222<ul class="blockList">
223<li class="blockList"><a name="constructor.detail">
224<!-- -->
225</a>
226<h3>Constructor Detail</h3>
227<a name="Pair-java.lang.Object-java.lang.Object-">
228<!-- -->
229</a><a name="Pair-A-B-">
230<!-- -->
231</a>
232<ul class="blockListLast">
233<li class="blockList">
234<h4>Pair</h4>
235<pre>public&nbsp;Pair(<a href="../../../genius/core/misc/Pair.html" title="type parameter in Pair">A</a>&nbsp;fst,
236 <a href="../../../genius/core/misc/Pair.html" title="type parameter in Pair">B</a>&nbsp;snd)</pre>
237<div class="block">Create a pair from the given two objects.</div>
238<dl>
239<dt><span class="paramLabel">Parameters:</span></dt>
240<dd><code>fst</code> - first object of the pair.</dd>
241<dd><code>snd</code> - second object of the pair.</dd>
242</dl>
243</li>
244</ul>
245</li>
246</ul>
247<!-- ============ METHOD DETAIL ========== -->
248<ul class="blockList">
249<li class="blockList"><a name="method.detail">
250<!-- -->
251</a>
252<h3>Method Detail</h3>
253<a name="getFirst--">
254<!-- -->
255</a>
256<ul class="blockList">
257<li class="blockList">
258<h4>getFirst</h4>
259<pre>public&nbsp;<a href="../../../genius/core/misc/Pair.html" title="type parameter in Pair">A</a>&nbsp;getFirst()</pre>
260<div class="block">Return the first object of the pair.</div>
261<dl>
262<dt><span class="returnLabel">Returns:</span></dt>
263<dd>first object of the pair.</dd>
264</dl>
265</li>
266</ul>
267<a name="getSecond--">
268<!-- -->
269</a>
270<ul class="blockList">
271<li class="blockList">
272<h4>getSecond</h4>
273<pre>public&nbsp;<a href="../../../genius/core/misc/Pair.html" title="type parameter in Pair">B</a>&nbsp;getSecond()</pre>
274<div class="block">Return the second object of the pair.</div>
275<dl>
276<dt><span class="returnLabel">Returns:</span></dt>
277<dd>second object of the pair.</dd>
278</dl>
279</li>
280</ul>
281<a name="setFirst-java.lang.Object-">
282<!-- -->
283</a><a name="setFirst-A-">
284<!-- -->
285</a>
286<ul class="blockList">
287<li class="blockList">
288<h4>setFirst</h4>
289<pre>public&nbsp;void&nbsp;setFirst(<a href="../../../genius/core/misc/Pair.html" title="type parameter in Pair">A</a>&nbsp;v)</pre>
290<div class="block">Set the first object of the pair.</div>
291<dl>
292<dt><span class="paramLabel">Parameters:</span></dt>
293<dd><code>v</code> - set first object to v.</dd>
294</dl>
295</li>
296</ul>
297<a name="setSecond-java.lang.Object-">
298<!-- -->
299</a><a name="setSecond-B-">
300<!-- -->
301</a>
302<ul class="blockList">
303<li class="blockList">
304<h4>setSecond</h4>
305<pre>public&nbsp;void&nbsp;setSecond(<a href="../../../genius/core/misc/Pair.html" title="type parameter in Pair">B</a>&nbsp;v)</pre>
306<div class="block">Set the second object of the pair.</div>
307<dl>
308<dt><span class="paramLabel">Parameters:</span></dt>
309<dd><code>v</code> - set second object to v.</dd>
310</dl>
311</li>
312</ul>
313<a name="toString--">
314<!-- -->
315</a>
316<ul class="blockList">
317<li class="blockList">
318<h4>toString</h4>
319<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
320<dl>
321<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
322<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
323<dt><span class="returnLabel">Returns:</span></dt>
324<dd>string representation of string.</dd>
325</dl>
326</li>
327</ul>
328<a name="equals-java.lang.Object-">
329<!-- -->
330</a>
331<ul class="blockList">
332<li class="blockList">
333<h4>equals</h4>
334<pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;other)</pre>
335<dl>
336<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
337<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
338<dt><span class="returnLabel">Returns:</span></dt>
339<dd>true if this and other object are equal.</dd>
340</dl>
341</li>
342</ul>
343<a name="hashCode--">
344<!-- -->
345</a>
346<ul class="blockListLast">
347<li class="blockList">
348<h4>hashCode</h4>
349<pre>public&nbsp;int&nbsp;hashCode()</pre>
350<dl>
351<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
352<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
353<dt><span class="returnLabel">Returns:</span></dt>
354<dd>hashcode of this object.</dd>
355</dl>
356</li>
357</ul>
358</li>
359</ul>
360</li>
361</ul>
362</div>
363</div>
364<!-- ========= END OF CLASS DATA ========= -->
365<!-- ======= START OF BOTTOM NAVBAR ====== -->
366<div class="bottomNav"><a name="navbar.bottom">
367<!-- -->
368</a>
369<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
370<a name="navbar.bottom.firstrow">
371<!-- -->
372</a>
373<ul class="navList" title="Navigation">
374<li><a href="../../../overview-summary.html">Overview</a></li>
375<li><a href="package-summary.html">Package</a></li>
376<li class="navBarCell1Rev">Class</li>
377<li><a href="class-use/Pair.html">Use</a></li>
378<li><a href="package-tree.html">Tree</a></li>
379<li><a href="../../../deprecated-list.html">Deprecated</a></li>
380<li><a href="../../../index-all.html">Index</a></li>
381<li><a href="../../../help-doc.html">Help</a></li>
382</ul>
383</div>
384<div class="subNav">
385<ul class="navList">
386<li><a href="../../../genius/core/misc/FileTools.html" title="class in genius.core.misc"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
387<li><a href="../../../genius/core/misc/Progress.html" title="class in genius.core.misc"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
388</ul>
389<ul class="navList">
390<li><a href="../../../index.html?genius/core/misc/Pair.html" target="_top">Frames</a></li>
391<li><a href="Pair.html" target="_top">No&nbsp;Frames</a></li>
392</ul>
393<ul class="navList" id="allclasses_navbar_bottom">
394<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
395</ul>
396<div>
397<script type="text/javascript"><!--
398 allClassesLink = document.getElementById("allclasses_navbar_bottom");
399 if(window==top) {
400 allClassesLink.style.display = "block";
401 }
402 else {
403 allClassesLink.style.display = "none";
404 }
405 //-->
406</script>
407</div>
408<div>
409<ul class="subNavList">
410<li>Summary:&nbsp;</li>
411<li>Nested&nbsp;|&nbsp;</li>
412<li>Field&nbsp;|&nbsp;</li>
413<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
414<li><a href="#method.summary">Method</a></li>
415</ul>
416<ul class="subNavList">
417<li>Detail:&nbsp;</li>
418<li>Field&nbsp;|&nbsp;</li>
419<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
420<li><a href="#method.detail">Method</a></li>
421</ul>
422</div>
423<a name="skip.navbar.bottom">
424<!-- -->
425</a></div>
426<!-- ======== END OF BOTTOM NAVBAR ======= -->
427</body>
428</html>
Note: See TracBrowser for help on using the repository browser.