source: javadoc/genius/core/analysis/ParetoFrontier.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: 12.5 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>ParetoFrontier (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="ParetoFrontier (Genius Core Documentation)";
16 }
17 }
18 catch(err) {
19 }
20//-->
21var methods = {"i0":10,"i1":10,"i2":10,"i3":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/ParetoFrontier.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/analysis/MultilateralAnalysis.html" title="class in genius.core.analysis"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
53<li>Next&nbsp;Class</li>
54</ul>
55<ul class="navList">
56<li><a href="../../../index.html?genius/core/analysis/ParetoFrontier.html" target="_top">Frames</a></li>
57<li><a href="ParetoFrontier.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 ParetoFrontier" class="title">Class ParetoFrontier</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.ParetoFrontier</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">ParetoFrontier</span>
117extends java.lang.Object
118implements java.io.Serializable</pre>
119<div class="block">Class which stores the Pareto-frontier. This class can be used to easily add
120 bids to the Pareto-frontier when calculating it.</div>
121<dl>
122<dt><span class="simpleTagLabel">Author:</span></dt>
123<dd>Tim Baarslag</dd>
124<dt><span class="seeLabel">See Also:</span></dt>
125<dd><a href="../../../serialized-form.html#genius.core.analysis.ParetoFrontier">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/analysis/ParetoFrontier.html#ParetoFrontier--">ParetoFrontier</a></span>()</code>
146<div class="block">Create an empty list to store the Pareto-frontier.</div>
147</td>
148</tr>
149</table>
150</li>
151</ul>
152<!-- ========== METHOD SUMMARY =========== -->
153<ul class="blockList">
154<li class="blockList"><a name="method.summary">
155<!-- -->
156</a>
157<h3>Method Summary</h3>
158<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
159<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>
160<tr>
161<th class="colFirst" scope="col">Modifier and Type</th>
162<th class="colLast" scope="col">Method and Description</th>
163</tr>
164<tr id="i0" class="altColor">
165<td class="colFirst"><code>java.util.List&lt;<a href="../../../genius/core/analysis/BidPoint.html" title="class in genius.core.analysis">BidPoint</a>&gt;</code></td>
166<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/analysis/ParetoFrontier.html#getFrontier--">getFrontier</a></span>()</code>
167<div class="block">Returns the Pareto-optimal frontier.</div>
168</td>
169</tr>
170<tr id="i1" class="rowColor">
171<td class="colFirst"><code>boolean</code></td>
172<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/analysis/ParetoFrontier.html#isBelowFrontier-genius.core.analysis.BidPoint-">isBelowFrontier</a></span>(<a href="../../../genius/core/analysis/BidPoint.html" title="class in genius.core.analysis">BidPoint</a>&nbsp;bid)</code>
173<div class="block">Returns true if the given BidPoint is not part of the Pareto-frontier.</div>
174</td>
175</tr>
176<tr id="i2" class="altColor">
177<td class="colFirst"><code>void</code></td>
178<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/analysis/ParetoFrontier.html#mergeIntoFrontier-genius.core.analysis.BidPoint-">mergeIntoFrontier</a></span>(<a href="../../../genius/core/analysis/BidPoint.html" title="class in genius.core.analysis">BidPoint</a>&nbsp;bidpoint)</code>
179<div class="block">Determines if a bid should be added to the Pareto-frontier.</div>
180</td>
181</tr>
182<tr id="i3" class="rowColor">
183<td class="colFirst"><code>void</code></td>
184<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/analysis/ParetoFrontier.html#sort--">sort</a></span>()</code>
185<div class="block">Order the bids based on the utility for agent A.</div>
186</td>
187</tr>
188</table>
189<ul class="blockList">
190<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
191<!-- -->
192</a>
193<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
194<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
195</ul>
196</li>
197</ul>
198</li>
199</ul>
200</div>
201<div class="details">
202<ul class="blockList">
203<li class="blockList">
204<!-- ========= CONSTRUCTOR DETAIL ======== -->
205<ul class="blockList">
206<li class="blockList"><a name="constructor.detail">
207<!-- -->
208</a>
209<h3>Constructor Detail</h3>
210<a name="ParetoFrontier--">
211<!-- -->
212</a>
213<ul class="blockListLast">
214<li class="blockList">
215<h4>ParetoFrontier</h4>
216<pre>public&nbsp;ParetoFrontier()</pre>
217<div class="block">Create an empty list to store the Pareto-frontier.</div>
218</li>
219</ul>
220</li>
221</ul>
222<!-- ============ METHOD DETAIL ========== -->
223<ul class="blockList">
224<li class="blockList"><a name="method.detail">
225<!-- -->
226</a>
227<h3>Method Detail</h3>
228<a name="mergeIntoFrontier-genius.core.analysis.BidPoint-">
229<!-- -->
230</a>
231<ul class="blockList">
232<li class="blockList">
233<h4>mergeIntoFrontier</h4>
234<pre>public&nbsp;void&nbsp;mergeIntoFrontier(<a href="../../../genius/core/analysis/BidPoint.html" title="class in genius.core.analysis">BidPoint</a>&nbsp;bidpoint)</pre>
235<div class="block">Determines if a bid should be added to the Pareto-frontier. A bid is
236 added when it strictly dominates a bid in the Pareto-frontier OR when it
237 is equal to a bid in the Pareto-frontier.</div>
238<dl>
239<dt><span class="paramLabel">Parameters:</span></dt>
240<dd><code>bidpoint</code> - bid to be added to the Pareto-frontier.</dd>
241</dl>
242</li>
243</ul>
244<a name="isBelowFrontier-genius.core.analysis.BidPoint-">
245<!-- -->
246</a>
247<ul class="blockList">
248<li class="blockList">
249<h4>isBelowFrontier</h4>
250<pre>public&nbsp;boolean&nbsp;isBelowFrontier(<a href="../../../genius/core/analysis/BidPoint.html" title="class in genius.core.analysis">BidPoint</a>&nbsp;bid)</pre>
251<div class="block">Returns true if the given BidPoint is not part of the Pareto-frontier.</div>
252<dl>
253<dt><span class="paramLabel">Parameters:</span></dt>
254<dd><code>bid</code> - to be checked if it is Pareto-optimal.</dd>
255<dt><span class="returnLabel">Returns:</span></dt>
256<dd>true if NOT pareto-optimal bid.</dd>
257</dl>
258</li>
259</ul>
260<a name="sort--">
261<!-- -->
262</a>
263<ul class="blockList">
264<li class="blockList">
265<h4>sort</h4>
266<pre>public&nbsp;void&nbsp;sort()</pre>
267<div class="block">Order the bids based on the utility for agent A.</div>
268</li>
269</ul>
270<a name="getFrontier--">
271<!-- -->
272</a>
273<ul class="blockListLast">
274<li class="blockList">
275<h4>getFrontier</h4>
276<pre>public&nbsp;java.util.List&lt;<a href="../../../genius/core/analysis/BidPoint.html" title="class in genius.core.analysis">BidPoint</a>&gt;&nbsp;getFrontier()</pre>
277<div class="block">Returns the Pareto-optimal frontier.</div>
278<dl>
279<dt><span class="returnLabel">Returns:</span></dt>
280<dd>Pareto-optimal frontier.</dd>
281</dl>
282</li>
283</ul>
284</li>
285</ul>
286</li>
287</ul>
288</div>
289</div>
290<!-- ========= END OF CLASS DATA ========= -->
291<!-- ======= START OF BOTTOM NAVBAR ====== -->
292<div class="bottomNav"><a name="navbar.bottom">
293<!-- -->
294</a>
295<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
296<a name="navbar.bottom.firstrow">
297<!-- -->
298</a>
299<ul class="navList" title="Navigation">
300<li><a href="../../../overview-summary.html">Overview</a></li>
301<li><a href="package-summary.html">Package</a></li>
302<li class="navBarCell1Rev">Class</li>
303<li><a href="class-use/ParetoFrontier.html">Use</a></li>
304<li><a href="package-tree.html">Tree</a></li>
305<li><a href="../../../deprecated-list.html">Deprecated</a></li>
306<li><a href="../../../index-all.html">Index</a></li>
307<li><a href="../../../help-doc.html">Help</a></li>
308</ul>
309</div>
310<div class="subNav">
311<ul class="navList">
312<li><a href="../../../genius/core/analysis/MultilateralAnalysis.html" title="class in genius.core.analysis"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
313<li>Next&nbsp;Class</li>
314</ul>
315<ul class="navList">
316<li><a href="../../../index.html?genius/core/analysis/ParetoFrontier.html" target="_top">Frames</a></li>
317<li><a href="ParetoFrontier.html" target="_top">No&nbsp;Frames</a></li>
318</ul>
319<ul class="navList" id="allclasses_navbar_bottom">
320<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
321</ul>
322<div>
323<script type="text/javascript"><!--
324 allClassesLink = document.getElementById("allclasses_navbar_bottom");
325 if(window==top) {
326 allClassesLink.style.display = "block";
327 }
328 else {
329 allClassesLink.style.display = "none";
330 }
331 //-->
332</script>
333</div>
334<div>
335<ul class="subNavList">
336<li>Summary:&nbsp;</li>
337<li>Nested&nbsp;|&nbsp;</li>
338<li>Field&nbsp;|&nbsp;</li>
339<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
340<li><a href="#method.summary">Method</a></li>
341</ul>
342<ul class="subNavList">
343<li>Detail:&nbsp;</li>
344<li>Field&nbsp;|&nbsp;</li>
345<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
346<li><a href="#method.detail">Method</a></li>
347</ul>
348</div>
349<a name="skip.navbar.bottom">
350<!-- -->
351</a></div>
352<!-- ======== END OF BOTTOM NAVBAR ======= -->
353</body>
354</html>
Note: See TracBrowser for help on using the repository browser.