source: javadoc/genius/core/bidding/BidDetails.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: 18.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:56 CEST 2018 -->
6<title>BidDetails (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="BidDetails (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,"i9":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/BidDetails.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/bidding/BidDetailsSorterTime.html" title="class in genius.core.bidding"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
54</ul>
55<ul class="navList">
56<li><a href="../../../index.html?genius/core/bidding/BidDetails.html" target="_top">Frames</a></li>
57<li><a href="BidDetails.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.bidding</div>
96<h2 title="Class BidDetails" class="title">Class BidDetails</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.bidding.BidDetails</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, java.lang.Comparable&lt;<a href="../../../genius/core/bidding/BidDetails.html" title="class in genius.core.bidding">BidDetails</a>&gt;</dd>
113</dl>
114<hr>
115<br>
116<pre>public class <span class="typeNameLabel">BidDetails</span>
117extends java.lang.Object
118implements java.lang.Comparable&lt;<a href="../../../genius/core/bidding/BidDetails.html" title="class in genius.core.bidding">BidDetails</a>&gt;, java.io.Serializable</pre>
119<div class="block">The BidDetails class is used to store a bid with it's corresponding utility and time it was offered.
120 In this way constant re-computation of the utility values is avoided.</div>
121<dl>
122<dt><span class="simpleTagLabel">Author:</span></dt>
123<dd>Tim Baarslag, Alex Dirkzwager, Mark Hendrikx</dd>
124<dt><span class="seeLabel">See Also:</span></dt>
125<dd><a href="../../../serialized-form.html#genius.core.bidding.BidDetails">Serialized Form</a></dd>
126</dl>
127</li>
128</ul>
129</div>
130<div class="summary">
131<ul class="blockList">
132<li class="blockList">
133<!-- ======== CONSTRUCTOR SUMMARY ======== -->
134<ul class="blockList">
135<li class="blockList"><a name="constructor.summary">
136<!-- -->
137</a>
138<h3>Constructor Summary</h3>
139<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
140<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
141<tr>
142<th class="colOne" scope="col">Constructor and Description</th>
143</tr>
144<tr class="altColor">
145<td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/bidding/BidDetails.html#BidDetails-genius.core.Bid-double-">BidDetails</a></span>(<a href="../../../genius/core/Bid.html" title="class in genius.core">Bid</a>&nbsp;bid,
146 double&nbsp;myUndiscountedUtil)</code>
147<div class="block">Creates a BidDetails-object which stores a bid with it's corresponding utility.</div>
148</td>
149</tr>
150<tr class="rowColor">
151<td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/bidding/BidDetails.html#BidDetails-genius.core.Bid-double-double-">BidDetails</a></span>(<a href="../../../genius/core/Bid.html" title="class in genius.core">Bid</a>&nbsp;bid,
152 double&nbsp;myUndiscountedUtil,
153 double&nbsp;time)</code>
154<div class="block">Creates a BidDetails-object which stores a bid with it's corresponding
155 utility and the time it was offered.</div>
156</td>
157</tr>
158</table>
159</li>
160</ul>
161<!-- ========== METHOD SUMMARY =========== -->
162<ul class="blockList">
163<li class="blockList"><a name="method.summary">
164<!-- -->
165</a>
166<h3>Method Summary</h3>
167<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
168<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>
169<tr>
170<th class="colFirst" scope="col">Modifier and Type</th>
171<th class="colLast" scope="col">Method and Description</th>
172</tr>
173<tr id="i0" class="altColor">
174<td class="colFirst"><code>int</code></td>
175<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/bidding/BidDetails.html#compareTo-genius.core.bidding.BidDetails-">compareTo</a></span>(<a href="../../../genius/core/bidding/BidDetails.html" title="class in genius.core.bidding">BidDetails</a>&nbsp;other)</code>
176<div class="block">A comparator for BidDetails which order the bids in
177 reverse natural order of utility.</div>
178</td>
179</tr>
180<tr id="i1" class="rowColor">
181<td class="colFirst"><code>boolean</code></td>
182<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/bidding/BidDetails.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>&nbsp;</td>
183</tr>
184<tr id="i2" class="altColor">
185<td class="colFirst"><code><a href="../../../genius/core/Bid.html" title="class in genius.core">Bid</a></code></td>
186<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/bidding/BidDetails.html#getBid--">getBid</a></span>()</code>
187<div class="block">Returns the bid.</div>
188</td>
189</tr>
190<tr id="i3" class="rowColor">
191<td class="colFirst"><code>double</code></td>
192<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/bidding/BidDetails.html#getMyUndiscountedUtil--">getMyUndiscountedUtil</a></span>()</code>
193<div class="block">Returns the undiscounted utility of the bid as supplied in the
194 constructor.</div>
195</td>
196</tr>
197<tr id="i4" class="altColor">
198<td class="colFirst"><code>double</code></td>
199<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/bidding/BidDetails.html#getTime--">getTime</a></span>()</code>
200<div class="block">Return the time at which this bid was offered.</div>
201</td>
202</tr>
203<tr id="i5" class="rowColor">
204<td class="colFirst"><code>int</code></td>
205<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/bidding/BidDetails.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
206</tr>
207<tr id="i6" class="altColor">
208<td class="colFirst"><code>void</code></td>
209<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/bidding/BidDetails.html#setBid-genius.core.Bid-">setBid</a></span>(<a href="../../../genius/core/Bid.html" title="class in genius.core">Bid</a>&nbsp;bid)</code>
210<div class="block">Set the bid.</div>
211</td>
212</tr>
213<tr id="i7" class="rowColor">
214<td class="colFirst"><code>void</code></td>
215<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/bidding/BidDetails.html#setMyUndiscountedUtil-double-">setMyUndiscountedUtil</a></span>(double&nbsp;utility)</code>
216<div class="block">Set the undiscounted utility of the bid.</div>
217</td>
218</tr>
219<tr id="i8" class="altColor">
220<td class="colFirst"><code>void</code></td>
221<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/bidding/BidDetails.html#setTime-double-">setTime</a></span>(double&nbsp;time)</code>
222<div class="block">Set the time at which this bid was offered.</div>
223</td>
224</tr>
225<tr id="i9" class="rowColor">
226<td class="colFirst"><code>java.lang.String</code></td>
227<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/bidding/BidDetails.html#toString--">toString</a></span>()</code>&nbsp;</td>
228</tr>
229</table>
230<ul class="blockList">
231<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
232<!-- -->
233</a>
234<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
235<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
236</ul>
237</li>
238</ul>
239</li>
240</ul>
241</div>
242<div class="details">
243<ul class="blockList">
244<li class="blockList">
245<!-- ========= CONSTRUCTOR DETAIL ======== -->
246<ul class="blockList">
247<li class="blockList"><a name="constructor.detail">
248<!-- -->
249</a>
250<h3>Constructor Detail</h3>
251<a name="BidDetails-genius.core.Bid-double-">
252<!-- -->
253</a>
254<ul class="blockList">
255<li class="blockList">
256<h4>BidDetails</h4>
257<pre>public&nbsp;BidDetails(<a href="../../../genius/core/Bid.html" title="class in genius.core">Bid</a>&nbsp;bid,
258 double&nbsp;myUndiscountedUtil)</pre>
259<div class="block">Creates a BidDetails-object which stores a bid with it's corresponding utility.</div>
260<dl>
261<dt><span class="paramLabel">Parameters:</span></dt>
262<dd><code>bid</code> - of an agent</dd>
263<dd><code>myUndiscountedUtil</code> - utility of the bid</dd>
264</dl>
265</li>
266</ul>
267<a name="BidDetails-genius.core.Bid-double-double-">
268<!-- -->
269</a>
270<ul class="blockListLast">
271<li class="blockList">
272<h4>BidDetails</h4>
273<pre>public&nbsp;BidDetails(<a href="../../../genius/core/Bid.html" title="class in genius.core">Bid</a>&nbsp;bid,
274 double&nbsp;myUndiscountedUtil,
275 double&nbsp;time)</pre>
276<div class="block">Creates a BidDetails-object which stores a bid with it's corresponding
277 utility and the time it was offered.</div>
278<dl>
279<dt><span class="paramLabel">Parameters:</span></dt>
280<dd><code>bid</code> - of an agent</dd>
281<dd><code>myUndiscountedUtil</code> - of the bid</dd>
282<dd><code>time</code> - of offering</dd>
283</dl>
284</li>
285</ul>
286</li>
287</ul>
288<!-- ============ METHOD DETAIL ========== -->
289<ul class="blockList">
290<li class="blockList"><a name="method.detail">
291<!-- -->
292</a>
293<h3>Method Detail</h3>
294<a name="getBid--">
295<!-- -->
296</a>
297<ul class="blockList">
298<li class="blockList">
299<h4>getBid</h4>
300<pre>public&nbsp;<a href="../../../genius/core/Bid.html" title="class in genius.core">Bid</a>&nbsp;getBid()</pre>
301<div class="block">Returns the bid.</div>
302<dl>
303<dt><span class="returnLabel">Returns:</span></dt>
304<dd>bid.</dd>
305</dl>
306</li>
307</ul>
308<a name="setBid-genius.core.Bid-">
309<!-- -->
310</a>
311<ul class="blockList">
312<li class="blockList">
313<h4>setBid</h4>
314<pre>public&nbsp;void&nbsp;setBid(<a href="../../../genius/core/Bid.html" title="class in genius.core">Bid</a>&nbsp;bid)</pre>
315<div class="block">Set the bid.</div>
316<dl>
317<dt><span class="paramLabel">Parameters:</span></dt>
318<dd><code>bid</code> - to be set in this object.</dd>
319</dl>
320</li>
321</ul>
322<a name="getMyUndiscountedUtil--">
323<!-- -->
324</a>
325<ul class="blockList">
326<li class="blockList">
327<h4>getMyUndiscountedUtil</h4>
328<pre>public&nbsp;double&nbsp;getMyUndiscountedUtil()</pre>
329<div class="block">Returns the undiscounted utility of the bid as supplied in the
330 constructor. Depending on the usage this can also be the utility
331 of the opponent if the BidDetails object was constructed by
332 the opponent model.</div>
333<dl>
334<dt><span class="returnLabel">Returns:</span></dt>
335<dd>undiscounted utility of bid.</dd>
336</dl>
337</li>
338</ul>
339<a name="setMyUndiscountedUtil-double-">
340<!-- -->
341</a>
342<ul class="blockList">
343<li class="blockList">
344<h4>setMyUndiscountedUtil</h4>
345<pre>public&nbsp;void&nbsp;setMyUndiscountedUtil(double&nbsp;utility)</pre>
346<div class="block">Set the undiscounted utility of the bid.</div>
347<dl>
348<dt><span class="paramLabel">Parameters:</span></dt>
349<dd><code>utility</code> - of the bid.</dd>
350</dl>
351</li>
352</ul>
353<a name="getTime--">
354<!-- -->
355</a>
356<ul class="blockList">
357<li class="blockList">
358<h4>getTime</h4>
359<pre>public&nbsp;double&nbsp;getTime()</pre>
360<div class="block">Return the time at which this bid was offered.</div>
361<dl>
362<dt><span class="returnLabel">Returns:</span></dt>
363<dd>time of offering.</dd>
364</dl>
365</li>
366</ul>
367<a name="setTime-double-">
368<!-- -->
369</a>
370<ul class="blockList">
371<li class="blockList">
372<h4>setTime</h4>
373<pre>public&nbsp;void&nbsp;setTime(double&nbsp;time)</pre>
374<div class="block">Set the time at which this bid was offered.</div>
375<dl>
376<dt><span class="paramLabel">Parameters:</span></dt>
377<dd><code>time</code> - of offering.</dd>
378</dl>
379</li>
380</ul>
381<a name="toString--">
382<!-- -->
383</a>
384<ul class="blockList">
385<li class="blockList">
386<h4>toString</h4>
387<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
388<dl>
389<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
390<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
391<dt><span class="returnLabel">Returns:</span></dt>
392<dd>string representation of the object (u=UTILITY, t=TIME).</dd>
393</dl>
394</li>
395</ul>
396<a name="compareTo-genius.core.bidding.BidDetails-">
397<!-- -->
398</a>
399<ul class="blockList">
400<li class="blockList">
401<h4>compareTo</h4>
402<pre>public&nbsp;int&nbsp;compareTo(<a href="../../../genius/core/bidding/BidDetails.html" title="class in genius.core.bidding">BidDetails</a>&nbsp;other)</pre>
403<div class="block">A comparator for BidDetails which order the bids in
404 reverse natural order of utility.</div>
405<dl>
406<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
407<dd><code>compareTo</code>&nbsp;in interface&nbsp;<code>java.lang.Comparable&lt;<a href="../../../genius/core/bidding/BidDetails.html" title="class in genius.core.bidding">BidDetails</a>&gt;</code></dd>
408<dt><span class="paramLabel">Parameters:</span></dt>
409<dd><code>other</code> - bid to which this bid is compared.</dd>
410<dt><span class="returnLabel">Returns:</span></dt>
411<dd>order of this bid relative to the given bid.</dd>
412</dl>
413</li>
414</ul>
415<a name="hashCode--">
416<!-- -->
417</a>
418<ul class="blockList">
419<li class="blockList">
420<h4>hashCode</h4>
421<pre>public&nbsp;int&nbsp;hashCode()</pre>
422<dl>
423<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
424<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
425<dt><span class="returnLabel">Returns:</span></dt>
426<dd>hashcode of this object.</dd>
427</dl>
428</li>
429</ul>
430<a name="equals-java.lang.Object-">
431<!-- -->
432</a>
433<ul class="blockListLast">
434<li class="blockList">
435<h4>equals</h4>
436<pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;obj)</pre>
437<dl>
438<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
439<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
440<dt><span class="paramLabel">Parameters:</span></dt>
441<dd><code>obj</code> - object to which this object is compared.</dd>
442<dt><span class="returnLabel">Returns:</span></dt>
443<dd>true if this object is equal to the given object.</dd>
444</dl>
445</li>
446</ul>
447</li>
448</ul>
449</li>
450</ul>
451</div>
452</div>
453<!-- ========= END OF CLASS DATA ========= -->
454<!-- ======= START OF BOTTOM NAVBAR ====== -->
455<div class="bottomNav"><a name="navbar.bottom">
456<!-- -->
457</a>
458<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
459<a name="navbar.bottom.firstrow">
460<!-- -->
461</a>
462<ul class="navList" title="Navigation">
463<li><a href="../../../overview-summary.html">Overview</a></li>
464<li><a href="package-summary.html">Package</a></li>
465<li class="navBarCell1Rev">Class</li>
466<li><a href="class-use/BidDetails.html">Use</a></li>
467<li><a href="package-tree.html">Tree</a></li>
468<li><a href="../../../deprecated-list.html">Deprecated</a></li>
469<li><a href="../../../index-all.html">Index</a></li>
470<li><a href="../../../help-doc.html">Help</a></li>
471</ul>
472</div>
473<div class="subNav">
474<ul class="navList">
475<li>Prev&nbsp;Class</li>
476<li><a href="../../../genius/core/bidding/BidDetailsSorterTime.html" title="class in genius.core.bidding"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
477</ul>
478<ul class="navList">
479<li><a href="../../../index.html?genius/core/bidding/BidDetails.html" target="_top">Frames</a></li>
480<li><a href="BidDetails.html" target="_top">No&nbsp;Frames</a></li>
481</ul>
482<ul class="navList" id="allclasses_navbar_bottom">
483<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
484</ul>
485<div>
486<script type="text/javascript"><!--
487 allClassesLink = document.getElementById("allclasses_navbar_bottom");
488 if(window==top) {
489 allClassesLink.style.display = "block";
490 }
491 else {
492 allClassesLink.style.display = "none";
493 }
494 //-->
495</script>
496</div>
497<div>
498<ul class="subNavList">
499<li>Summary:&nbsp;</li>
500<li>Nested&nbsp;|&nbsp;</li>
501<li>Field&nbsp;|&nbsp;</li>
502<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
503<li><a href="#method.summary">Method</a></li>
504</ul>
505<ul class="subNavList">
506<li>Detail:&nbsp;</li>
507<li>Field&nbsp;|&nbsp;</li>
508<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
509<li><a href="#method.detail">Method</a></li>
510</ul>
511</div>
512<a name="skip.navbar.bottom">
513<!-- -->
514</a></div>
515<!-- ======== END OF BOTTOM NAVBAR ======= -->
516</body>
517</html>
Note: See TracBrowser for help on using the repository browser.