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