source: javadoc/genius/core/analysis/BidPoint.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: 16.9 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:56 CEST 2018 -->
6<title>BidPoint (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="BidPoint (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,"i7":10,"i8":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/BidPoint.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>Prev&nbsp;Class</li>
53<li><a href="../../../genius/core/analysis/BidPointSorterA.html" title="class in genius.core.analysis"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
54</ul>
55<ul class="navList">
56<li><a href="../../../index.html?genius/core/analysis/BidPoint.html" target="_top">Frames</a></li>
57<li><a href="BidPoint.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.analysis</div>
96<h2 title="Class BidPoint" class="title">Class BidPoint</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.analysis.BidPoint</li>
104</ul>
105</li>
106</ul>
107<div class="description">
108<ul class="blockList">
109<li class="blockList">
110<dl>
111<dt>All Implemented Interfaces:</dt>
112<dd>java.io.Serializable</dd>
113</dl>
114<dl>
115<dt>Direct Known Subclasses:</dt>
116<dd><a href="../../../genius/core/analysis/BidPointTime.html" title="class in genius.core.analysis">BidPointTime</a></dd>
117</dl>
118<hr>
119<br>
120<pre>public class <span class="typeNameLabel">BidPoint</span>
121extends java.lang.Object
122implements java.io.Serializable</pre>
123<div class="block">A BidPoint is a tuple which contains the utility of a particular bid for each
124 agent.</div>
125<dl>
126<dt><span class="simpleTagLabel">Author:</span></dt>
127<dd>Tim Baarslag, Dmytro Tykhonov, Mark Hendrikx</dd>
128<dt><span class="seeLabel">See Also:</span></dt>
129<dd><a href="../../../serialized-form.html#genius.core.analysis.BidPoint">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/analysis/BidPoint.html#BidPoint-genius.core.Bid-java.lang.Double...-">BidPoint</a></span>(<a href="../../../genius/core/Bid.html" title="class in genius.core">Bid</a>&nbsp;bid,
150 java.lang.Double...&nbsp;utility)</code>
151<div class="block">Create a BidPoint by given the bid and the tuple of utilities for that
152 bid.</div>
153</td>
154</tr>
155</table>
156</li>
157</ul>
158<!-- ========== METHOD SUMMARY =========== -->
159<ul class="blockList">
160<li class="blockList"><a name="method.summary">
161<!-- -->
162</a>
163<h3>Method Summary</h3>
164<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
165<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>
166<tr>
167<th class="colFirst" scope="col">Modifier and Type</th>
168<th class="colLast" scope="col">Method and Description</th>
169</tr>
170<tr id="i0" class="altColor">
171<td class="colFirst"><code>boolean</code></td>
172<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/analysis/BidPoint.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>&nbsp;</td>
173</tr>
174<tr id="i1" class="rowColor">
175<td class="colFirst"><code><a href="../../../genius/core/Bid.html" title="class in genius.core">Bid</a></code></td>
176<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/analysis/BidPoint.html#getBid--">getBid</a></span>()</code>
177<div class="block">Bid from which the utilities are represented.</div>
178</td>
179</tr>
180<tr id="i2" class="altColor">
181<td class="colFirst"><code>double</code></td>
182<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/analysis/BidPoint.html#getDistance-genius.core.analysis.BidPoint-">getDistance</a></span>(<a href="../../../genius/core/analysis/BidPoint.html" title="class in genius.core.analysis">BidPoint</a>&nbsp;other)</code>
183<div class="block">Returns the distance between this BidPoint and another BidPoint.</div>
184</td>
185</tr>
186<tr id="i3" class="rowColor">
187<td class="colFirst"><code>java.lang.Double</code></td>
188<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/analysis/BidPoint.html#getUtility-int-">getUtility</a></span>(int&nbsp;index)</code>
189<div class="block">Returns the utility of the bid for the i'th agent (agent A = 0, etc.).</div>
190</td>
191</tr>
192<tr id="i4" class="altColor">
193<td class="colFirst"><code>java.lang.Double</code></td>
194<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/analysis/BidPoint.html#getUtilityA--">getUtilityA</a></span>()</code>
195<div class="block">Returns the utility of the bid for agent A.</div>
196</td>
197</tr>
198<tr id="i5" class="rowColor">
199<td class="colFirst"><code>java.lang.Double</code></td>
200<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/analysis/BidPoint.html#getUtilityB--">getUtilityB</a></span>()</code>
201<div class="block">Returns the utility of the bid for agent B.</div>
202</td>
203</tr>
204<tr id="i6" class="altColor">
205<td class="colFirst"><code>int</code></td>
206<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/analysis/BidPoint.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
207</tr>
208<tr id="i7" class="rowColor">
209<td class="colFirst"><code>boolean</code></td>
210<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/analysis/BidPoint.html#isStrictlyDominatedBy-genius.core.analysis.BidPoint-">isStrictlyDominatedBy</a></span>(<a href="../../../genius/core/analysis/BidPoint.html" title="class in genius.core.analysis">BidPoint</a>&nbsp;other)</code>
211<div class="block">Returns true if this BidPoint is strictly dominated by another BidPoint.</div>
212</td>
213</tr>
214<tr id="i8" class="altColor">
215<td class="colFirst"><code>java.lang.String</code></td>
216<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/analysis/BidPoint.html#toString--">toString</a></span>()</code>&nbsp;</td>
217</tr>
218</table>
219<ul class="blockList">
220<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
221<!-- -->
222</a>
223<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
224<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
225</ul>
226</li>
227</ul>
228</li>
229</ul>
230</div>
231<div class="details">
232<ul class="blockList">
233<li class="blockList">
234<!-- ========= CONSTRUCTOR DETAIL ======== -->
235<ul class="blockList">
236<li class="blockList"><a name="constructor.detail">
237<!-- -->
238</a>
239<h3>Constructor Detail</h3>
240<a name="BidPoint-genius.core.Bid-java.lang.Double...-">
241<!-- -->
242</a>
243<ul class="blockListLast">
244<li class="blockList">
245<h4>BidPoint</h4>
246<pre>public&nbsp;BidPoint(<a href="../../../genius/core/Bid.html" title="class in genius.core">Bid</a>&nbsp;bid,
247 java.lang.Double...&nbsp;utility)</pre>
248<div class="block">Create a BidPoint by given the bid and the tuple of utilities for that
249 bid.</div>
250<dl>
251<dt><span class="paramLabel">Parameters:</span></dt>
252<dd><code>bid</code> - from which the utilities are stored.</dd>
253<dd><code>utility</code> - tuple of utilities of the bid.</dd>
254</dl>
255</li>
256</ul>
257</li>
258</ul>
259<!-- ============ METHOD DETAIL ========== -->
260<ul class="blockList">
261<li class="blockList"><a name="method.detail">
262<!-- -->
263</a>
264<h3>Method Detail</h3>
265<a name="toString--">
266<!-- -->
267</a>
268<ul class="blockList">
269<li class="blockList">
270<h4>toString</h4>
271<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
272<dl>
273<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
274<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
275<dt><span class="returnLabel">Returns:</span></dt>
276<dd>string representation of the object.</dd>
277</dl>
278</li>
279</ul>
280<a name="equals-java.lang.Object-">
281<!-- -->
282</a>
283<ul class="blockList">
284<li class="blockList">
285<h4>equals</h4>
286<pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;obj)</pre>
287<dl>
288<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
289<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
290<dt><span class="paramLabel">Parameters:</span></dt>
291<dd><code>obj</code> - object to which this object is compared.</dd>
292<dt><span class="returnLabel">Returns:</span></dt>
293<dd>true if this object is equal to the given object.</dd>
294</dl>
295</li>
296</ul>
297<a name="hashCode--">
298<!-- -->
299</a>
300<ul class="blockList">
301<li class="blockList">
302<h4>hashCode</h4>
303<pre>public&nbsp;int&nbsp;hashCode()</pre>
304<dl>
305<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
306<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
307<dt><span class="returnLabel">Returns:</span></dt>
308<dd>hashcode of this object.</dd>
309</dl>
310</li>
311</ul>
312<a name="getBid--">
313<!-- -->
314</a>
315<ul class="blockList">
316<li class="blockList">
317<h4>getBid</h4>
318<pre>public&nbsp;<a href="../../../genius/core/Bid.html" title="class in genius.core">Bid</a>&nbsp;getBid()</pre>
319<div class="block">Bid from which the utilities are represented. This bid may be null to
320 save memory.</div>
321<dl>
322<dt><span class="returnLabel">Returns:</span></dt>
323<dd>bid which utilities are represented.</dd>
324</dl>
325</li>
326</ul>
327<a name="getUtility-int-">
328<!-- -->
329</a>
330<ul class="blockList">
331<li class="blockList">
332<h4>getUtility</h4>
333<pre>public&nbsp;java.lang.Double&nbsp;getUtility(int&nbsp;index)</pre>
334<div class="block">Returns the utility of the bid for the i'th agent (agent A = 0, etc.).</div>
335<dl>
336<dt><span class="paramLabel">Parameters:</span></dt>
337<dd><code>index</code> - of the agent of which the utility should be returned.</dd>
338<dt><span class="returnLabel">Returns:</span></dt>
339<dd>utility of the bid for the i'th agent.</dd>
340</dl>
341</li>
342</ul>
343<a name="getUtilityA--">
344<!-- -->
345</a>
346<ul class="blockList">
347<li class="blockList">
348<h4>getUtilityA</h4>
349<pre>public&nbsp;java.lang.Double&nbsp;getUtilityA()</pre>
350<div class="block">Returns the utility of the bid for agent A.</div>
351<dl>
352<dt><span class="returnLabel">Returns:</span></dt>
353<dd>utility for agent A.</dd>
354</dl>
355</li>
356</ul>
357<a name="getUtilityB--">
358<!-- -->
359</a>
360<ul class="blockList">
361<li class="blockList">
362<h4>getUtilityB</h4>
363<pre>public&nbsp;java.lang.Double&nbsp;getUtilityB()</pre>
364<div class="block">Returns the utility of the bid for agent B.</div>
365<dl>
366<dt><span class="returnLabel">Returns:</span></dt>
367<dd>utility for agent B.</dd>
368</dl>
369</li>
370</ul>
371<a name="isStrictlyDominatedBy-genius.core.analysis.BidPoint-">
372<!-- -->
373</a>
374<ul class="blockList">
375<li class="blockList">
376<h4>isStrictlyDominatedBy</h4>
377<pre>public&nbsp;boolean&nbsp;isStrictlyDominatedBy(<a href="../../../genius/core/analysis/BidPoint.html" title="class in genius.core.analysis">BidPoint</a>&nbsp;other)</pre>
378<div class="block">Returns true if this BidPoint is strictly dominated by another BidPoint.
379 A BidPoint is dominated when the utility of the other bid for at least
380 one agent is higher and equal for the other agent.</div>
381<dl>
382<dt><span class="paramLabel">Parameters:</span></dt>
383<dd><code>other</code> - BidPoint.</dd>
384<dt><span class="returnLabel">Returns:</span></dt>
385<dd>true if "other" dominates "this".</dd>
386</dl>
387</li>
388</ul>
389<a name="getDistance-genius.core.analysis.BidPoint-">
390<!-- -->
391</a>
392<ul class="blockListLast">
393<li class="blockList">
394<h4>getDistance</h4>
395<pre>public&nbsp;double&nbsp;getDistance(<a href="../../../genius/core/analysis/BidPoint.html" title="class in genius.core.analysis">BidPoint</a>&nbsp;other)</pre>
396<div class="block">Returns the distance between this BidPoint and another BidPoint. sqrt((Tx
397 - Ox) ^ 2 + (Ty - Oy) ^ 2 + ...).</div>
398<dl>
399<dt><span class="paramLabel">Parameters:</span></dt>
400<dd><code>other</code> - bidpoint to which the distance is calculated.</dd>
401<dt><span class="returnLabel">Returns:</span></dt>
402<dd>distance to the given bidpoint.</dd>
403</dl>
404</li>
405</ul>
406</li>
407</ul>
408</li>
409</ul>
410</div>
411</div>
412<!-- ========= END OF CLASS DATA ========= -->
413<!-- ======= START OF BOTTOM NAVBAR ====== -->
414<div class="bottomNav"><a name="navbar.bottom">
415<!-- -->
416</a>
417<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
418<a name="navbar.bottom.firstrow">
419<!-- -->
420</a>
421<ul class="navList" title="Navigation">
422<li><a href="../../../overview-summary.html">Overview</a></li>
423<li><a href="package-summary.html">Package</a></li>
424<li class="navBarCell1Rev">Class</li>
425<li><a href="class-use/BidPoint.html">Use</a></li>
426<li><a href="package-tree.html">Tree</a></li>
427<li><a href="../../../deprecated-list.html">Deprecated</a></li>
428<li><a href="../../../index-all.html">Index</a></li>
429<li><a href="../../../help-doc.html">Help</a></li>
430</ul>
431</div>
432<div class="subNav">
433<ul class="navList">
434<li>Prev&nbsp;Class</li>
435<li><a href="../../../genius/core/analysis/BidPointSorterA.html" title="class in genius.core.analysis"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
436</ul>
437<ul class="navList">
438<li><a href="../../../index.html?genius/core/analysis/BidPoint.html" target="_top">Frames</a></li>
439<li><a href="BidPoint.html" target="_top">No&nbsp;Frames</a></li>
440</ul>
441<ul class="navList" id="allclasses_navbar_bottom">
442<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
443</ul>
444<div>
445<script type="text/javascript"><!--
446 allClassesLink = document.getElementById("allclasses_navbar_bottom");
447 if(window==top) {
448 allClassesLink.style.display = "block";
449 }
450 else {
451 allClassesLink.style.display = "none";
452 }
453 //-->
454</script>
455</div>
456<div>
457<ul class="subNavList">
458<li>Summary:&nbsp;</li>
459<li>Nested&nbsp;|&nbsp;</li>
460<li>Field&nbsp;|&nbsp;</li>
461<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
462<li><a href="#method.summary">Method</a></li>
463</ul>
464<ul class="subNavList">
465<li>Detail:&nbsp;</li>
466<li>Field&nbsp;|&nbsp;</li>
467<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
468<li><a href="#method.detail">Method</a></li>
469</ul>
470</div>
471<a name="skip.navbar.bottom">
472<!-- -->
473</a></div>
474<!-- ======== END OF BOTTOM NAVBAR ======= -->
475</body>
476</html>
Note: See TracBrowser for help on using the repository browser.