source: javadoc/genius/core/utility/UtilitySpaceTools.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:58 CEST 2018 -->
6<title>UtilitySpaceTools (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="UtilitySpaceTools (Genius Core Documentation)";
16 }
17 }
18 catch(err) {
19 }
20//-->
21var methods = {"i0":10,"i1":10,"i2":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/UtilitySpaceTools.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/utility/UtilitySpace.html" title="interface in genius.core.utility"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
53<li><a href="../../../genius/core/utility/UTILITYSPACETYPE.html" title="enum in genius.core.utility"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
54</ul>
55<ul class="navList">
56<li><a href="../../../index.html?genius/core/utility/UtilitySpaceTools.html" target="_top">Frames</a></li>
57<li><a href="UtilitySpaceTools.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.utility</div>
96<h2 title="Class UtilitySpaceTools" class="title">Class UtilitySpaceTools</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.utility.UtilitySpaceTools</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<hr>
115<br>
116<pre>public class <span class="typeNameLabel">UtilitySpaceTools</span>
117extends java.lang.Object
118implements java.io.Serializable</pre>
119<div class="block">Companion class to <a href="../../../genius/core/utility/UtilitySpace.html" title="interface in genius.core.utility"><code>UtilitySpace</code></a>. Some utility functions that work on
120 a utility space. Works as an add-on on a given <a href="../../../genius/core/utility/UtilitySpace.html" title="interface in genius.core.utility"><code>UtilitySpace</code></a>. Does not
121 extend it, so that receivers of an abstract <a href="../../../genius/core/utility/UtilitySpace.html" title="interface in genius.core.utility"><code>UtilitySpace</code></a> can connect
122 it with these tools too.
123 <p>
124 This is a class, not a set of static functions, to allow caching of results
125 (not yet implemented). Serializable so that eg AbstractuUtilitySpace can use
126 this as inner class and store cached results.</div>
127<dl>
128<dt><span class="seeLabel">See Also:</span></dt>
129<dd><a href="../../../serialized-form.html#genius.core.utility.UtilitySpaceTools">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/utility/UtilitySpaceTools.html#UtilitySpaceTools-genius.core.utility.UtilitySpace-">UtilitySpaceTools</a></span>(<a href="../../../genius/core/utility/UtilitySpace.html" title="interface in genius.core.utility">UtilitySpace</a>&nbsp;space)</code>&nbsp;</td>
150</tr>
151</table>
152</li>
153</ul>
154<!-- ========== METHOD SUMMARY =========== -->
155<ul class="blockList">
156<li class="blockList"><a name="method.summary">
157<!-- -->
158</a>
159<h3>Method Summary</h3>
160<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
161<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>
162<tr>
163<th class="colFirst" scope="col">Modifier and Type</th>
164<th class="colLast" scope="col">Method and Description</th>
165</tr>
166<tr id="i0" class="altColor">
167<td class="colFirst"><code>void</code></td>
168<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/UtilitySpaceTools.html#checkReadyForNegotiation-genius.core.Domain-">checkReadyForNegotiation</a></span>(<a href="../../../genius/core/Domain.html" title="interface in genius.core">Domain</a>&nbsp;dom)</code>
169<div class="block">Check if this utility space is ready for negotiation.</div>
170</td>
171</tr>
172<tr id="i1" class="rowColor">
173<td class="colFirst"><code><a href="../../../genius/core/Bid.html" title="class in genius.core">Bid</a></code></td>
174<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/UtilitySpaceTools.html#getMaxUtilityBid--">getMaxUtilityBid</a></span>()</code>
175<div class="block">Returns the maximum bid in the utility space.</div>
176</td>
177</tr>
178<tr id="i2" class="altColor">
179<td class="colFirst"><code><a href="../../../genius/core/Bid.html" title="class in genius.core">Bid</a></code></td>
180<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/UtilitySpaceTools.html#getMinUtilityBid--">getMinUtilityBid</a></span>()</code>
181<div class="block">Returns the worst bid in the utility space.</div>
182</td>
183</tr>
184</table>
185<ul class="blockList">
186<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
187<!-- -->
188</a>
189<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
190<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
191</ul>
192</li>
193</ul>
194</li>
195</ul>
196</div>
197<div class="details">
198<ul class="blockList">
199<li class="blockList">
200<!-- ========= CONSTRUCTOR DETAIL ======== -->
201<ul class="blockList">
202<li class="blockList"><a name="constructor.detail">
203<!-- -->
204</a>
205<h3>Constructor Detail</h3>
206<a name="UtilitySpaceTools-genius.core.utility.UtilitySpace-">
207<!-- -->
208</a>
209<ul class="blockListLast">
210<li class="blockList">
211<h4>UtilitySpaceTools</h4>
212<pre>public&nbsp;UtilitySpaceTools(<a href="../../../genius/core/utility/UtilitySpace.html" title="interface in genius.core.utility">UtilitySpace</a>&nbsp;space)</pre>
213</li>
214</ul>
215</li>
216</ul>
217<!-- ============ METHOD DETAIL ========== -->
218<ul class="blockList">
219<li class="blockList"><a name="method.detail">
220<!-- -->
221</a>
222<h3>Method Detail</h3>
223<a name="getMaxUtilityBid--">
224<!-- -->
225</a>
226<ul class="blockList">
227<li class="blockList">
228<h4>getMaxUtilityBid</h4>
229<pre>public final&nbsp;<a href="../../../genius/core/Bid.html" title="class in genius.core">Bid</a>&nbsp;getMaxUtilityBid()</pre>
230<div class="block">Returns the maximum bid in the utility space. This is only supported for
231 linear utility spaces. Expensive: this does a brute-force search through
232 bidspace.</div>
233<dl>
234<dt><span class="returnLabel">Returns:</span></dt>
235<dd>a bid with the maximum utility value attainable in this util
236 space</dd>
237<dt><span class="throwsLabel">Throws:</span></dt>
238<dd><code>java.lang.IllegalStateException</code> - if there is no bid at all in this util space.</dd>
239</dl>
240</li>
241</ul>
242<a name="getMinUtilityBid--">
243<!-- -->
244</a>
245<ul class="blockList">
246<li class="blockList">
247<h4>getMinUtilityBid</h4>
248<pre>public&nbsp;<a href="../../../genius/core/Bid.html" title="class in genius.core">Bid</a>&nbsp;getMinUtilityBid()</pre>
249<div class="block">Returns the worst bid in the utility space. This is only supported for
250 linear utility spaces.</div>
251<dl>
252<dt><span class="returnLabel">Returns:</span></dt>
253<dd>a bid with the lowest possible utility</dd>
254<dt><span class="throwsLabel">Throws:</span></dt>
255<dd><code>java.lang.IllegalStateException</code> - if there is no bid at all in the util space</dd>
256</dl>
257</li>
258</ul>
259<a name="checkReadyForNegotiation-genius.core.Domain-">
260<!-- -->
261</a>
262<ul class="blockListLast">
263<li class="blockList">
264<h4>checkReadyForNegotiation</h4>
265<pre>public&nbsp;void&nbsp;checkReadyForNegotiation(<a href="../../../genius/core/Domain.html" title="interface in genius.core">Domain</a>&nbsp;dom)</pre>
266<div class="block">Check if this utility space is ready for negotiation. To be so, the
267 domain must match the given domain and the space must be complete.</div>
268<dl>
269<dt><span class="paramLabel">Parameters:</span></dt>
270<dd><code>dom</code> - is the domain in which nego is taking place</dd>
271<dt><span class="throwsLabel">Throws:</span></dt>
272<dd><code>java.lang.IllegalStateException</code> - if there is somethign wrong with this domain</dd>
273</dl>
274</li>
275</ul>
276</li>
277</ul>
278</li>
279</ul>
280</div>
281</div>
282<!-- ========= END OF CLASS DATA ========= -->
283<!-- ======= START OF BOTTOM NAVBAR ====== -->
284<div class="bottomNav"><a name="navbar.bottom">
285<!-- -->
286</a>
287<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
288<a name="navbar.bottom.firstrow">
289<!-- -->
290</a>
291<ul class="navList" title="Navigation">
292<li><a href="../../../overview-summary.html">Overview</a></li>
293<li><a href="package-summary.html">Package</a></li>
294<li class="navBarCell1Rev">Class</li>
295<li><a href="class-use/UtilitySpaceTools.html">Use</a></li>
296<li><a href="package-tree.html">Tree</a></li>
297<li><a href="../../../deprecated-list.html">Deprecated</a></li>
298<li><a href="../../../index-all.html">Index</a></li>
299<li><a href="../../../help-doc.html">Help</a></li>
300</ul>
301</div>
302<div class="subNav">
303<ul class="navList">
304<li><a href="../../../genius/core/utility/UtilitySpace.html" title="interface in genius.core.utility"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
305<li><a href="../../../genius/core/utility/UTILITYSPACETYPE.html" title="enum in genius.core.utility"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
306</ul>
307<ul class="navList">
308<li><a href="../../../index.html?genius/core/utility/UtilitySpaceTools.html" target="_top">Frames</a></li>
309<li><a href="UtilitySpaceTools.html" target="_top">No&nbsp;Frames</a></li>
310</ul>
311<ul class="navList" id="allclasses_navbar_bottom">
312<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
313</ul>
314<div>
315<script type="text/javascript"><!--
316 allClassesLink = document.getElementById("allclasses_navbar_bottom");
317 if(window==top) {
318 allClassesLink.style.display = "block";
319 }
320 else {
321 allClassesLink.style.display = "none";
322 }
323 //-->
324</script>
325</div>
326<div>
327<ul class="subNavList">
328<li>Summary:&nbsp;</li>
329<li>Nested&nbsp;|&nbsp;</li>
330<li>Field&nbsp;|&nbsp;</li>
331<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
332<li><a href="#method.summary">Method</a></li>
333</ul>
334<ul class="subNavList">
335<li>Detail:&nbsp;</li>
336<li>Field&nbsp;|&nbsp;</li>
337<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
338<li><a href="#method.detail">Method</a></li>
339</ul>
340</div>
341<a name="skip.navbar.bottom">
342<!-- -->
343</a></div>
344<!-- ======== END OF BOTTOM NAVBAR ======= -->
345</body>
346</html>
Note: See TracBrowser for help on using the repository browser.