source: javadoc/genius/core/utility/Evaluator.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.8 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>Evaluator (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="Evaluator (Genius Core Documentation)";
16 }
17 }
18 catch(err) {
19 }
20//-->
21var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6};
22var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/Evaluator.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/EVALFUNCTYPE.html" title="enum in genius.core.utility"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
53<li><a href="../../../genius/core/utility/EvaluatorDiscrete.html" title="class 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/Evaluator.html" target="_top">Frames</a></li>
57<li><a href="Evaluator.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>Constr&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>Constr&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="Interface Evaluator" class="title">Interface Evaluator</h2>
97</div>
98<div class="contentContainer">
99<div class="description">
100<ul class="blockList">
101<li class="blockList">
102<dl>
103<dt>All Superinterfaces:</dt>
104<dd>java.io.Serializable</dd>
105</dl>
106<dl>
107<dt>All Known Implementing Classes:</dt>
108<dd><a href="../../../genius/core/utility/EvaluatorDiscrete.html" title="class in genius.core.utility">EvaluatorDiscrete</a>, <a href="../../../genius/core/utility/EvaluatorInteger.html" title="class in genius.core.utility">EvaluatorInteger</a>, <a href="../../../genius/core/utility/EvaluatorObjective.html" title="class in genius.core.utility">EvaluatorObjective</a>, <a href="../../../genius/core/utility/EvaluatorReal.html" title="class in genius.core.utility">EvaluatorReal</a></dd>
109</dl>
110<hr>
111<br>
112<pre>public interface <span class="typeNameLabel">Evaluator</span>
113extends java.io.Serializable</pre>
114<div class="block">Evaluator is an object that translates discrete values into an evaluation
115 value. The UtilitySpace attaches it to an issue.</div>
116<dl>
117<dt><span class="simpleTagLabel">Author:</span></dt>
118<dd>Dmytro</dd>
119</dl>
120</li>
121</ul>
122</div>
123<div class="summary">
124<ul class="blockList">
125<li class="blockList">
126<!-- ========== METHOD SUMMARY =========== -->
127<ul class="blockList">
128<li class="blockList"><a name="method.summary">
129<!-- -->
130</a>
131<h3>Method Summary</h3>
132<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
133<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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
134<tr>
135<th class="colFirst" scope="col">Modifier and Type</th>
136<th class="colLast" scope="col">Method and Description</th>
137</tr>
138<tr id="i0" class="altColor">
139<td class="colFirst"><code><a href="../../../genius/core/utility/Evaluator.html" title="interface in genius.core.utility">Evaluator</a></code></td>
140<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/Evaluator.html#clone--">clone</a></span>()</code>&nbsp;</td>
141</tr>
142<tr id="i1" class="rowColor">
143<td class="colFirst"><code>java.lang.Double</code></td>
144<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/Evaluator.html#getEvaluation-genius.core.utility.AdditiveUtilitySpace-genius.core.Bid-int-">getEvaluation</a></span>(<a href="../../../genius/core/utility/AdditiveUtilitySpace.html" title="class in genius.core.utility">AdditiveUtilitySpace</a>&nbsp;uspace,
145 <a href="../../../genius/core/Bid.html" title="class in genius.core">Bid</a>&nbsp;bid,
146 int&nbsp;index)</code>
147<div class="block">This method returns the utility of the value of an issue.</div>
148</td>
149</tr>
150<tr id="i2" class="altColor">
151<td class="colFirst"><code><a href="../../../genius/core/utility/EVALUATORTYPE.html" title="enum in genius.core.utility">EVALUATORTYPE</a></code></td>
152<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/Evaluator.html#getType--">getType</a></span>()</code>&nbsp;</td>
153</tr>
154<tr id="i3" class="rowColor">
155<td class="colFirst"><code>double</code></td>
156<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/Evaluator.html#getWeight--">getWeight</a></span>()</code>&nbsp;</td>
157</tr>
158<tr id="i4" class="altColor">
159<td class="colFirst"><code>java.lang.String</code></td>
160<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/Evaluator.html#isComplete-genius.core.issue.Objective-">isComplete</a></span>(<a href="../../../genius/core/issue/Objective.html" title="class in genius.core.issue">Objective</a>&nbsp;whichObjective)</code>
161<div class="block">Check whether the evaluator has enough information to make an evaluation.</div>
162</td>
163</tr>
164<tr id="i5" class="rowColor">
165<td class="colFirst"><code>void</code></td>
166<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/Evaluator.html#loadFromXML-genius.core.xml.SimpleElement-">loadFromXML</a></span>(<a href="../../../genius/core/xml/SimpleElement.html" title="class in genius.core.xml">SimpleElement</a>&nbsp;pRoot)</code>
167<div class="block">Load the evaluator from an XML file</div>
168</td>
169</tr>
170<tr id="i6" class="altColor">
171<td class="colFirst"><code>void</code></td>
172<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/Evaluator.html#lockWeight--">lockWeight</a></span>()</code>
173<div class="block">lockWeight is a flag affecting the behaviour of the normalize function in
174 the utility space.</div>
175</td>
176</tr>
177<tr id="i7" class="rowColor">
178<td class="colFirst"><code>void</code></td>
179<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/Evaluator.html#setWeight-double-">setWeight</a></span>(double&nbsp;wt)</code>
180<div class="block">Sets the weigth with which an Objective or Issue is evaluated.</div>
181</td>
182</tr>
183<tr id="i8" class="altColor">
184<td class="colFirst"><code>void</code></td>
185<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/Evaluator.html#unlockWeight--">unlockWeight</a></span>()</code>
186<div class="block">Method to unlock a weight.</div>
187</td>
188</tr>
189<tr id="i9" class="rowColor">
190<td class="colFirst"><code>boolean</code></td>
191<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/Evaluator.html#weightLocked--">weightLocked</a></span>()</code>&nbsp;</td>
192</tr>
193</table>
194</li>
195</ul>
196</li>
197</ul>
198</div>
199<div class="details">
200<ul class="blockList">
201<li class="blockList">
202<!-- ============ METHOD DETAIL ========== -->
203<ul class="blockList">
204<li class="blockList"><a name="method.detail">
205<!-- -->
206</a>
207<h3>Method Detail</h3>
208<a name="getWeight--">
209<!-- -->
210</a>
211<ul class="blockList">
212<li class="blockList">
213<h4>getWeight</h4>
214<pre>double&nbsp;getWeight()</pre>
215<dl>
216<dt><span class="returnLabel">Returns:</span></dt>
217<dd>the weight associated with this, a value in [0,1]</dd>
218</dl>
219</li>
220</ul>
221<a name="setWeight-double-">
222<!-- -->
223</a>
224<ul class="blockList">
225<li class="blockList">
226<h4>setWeight</h4>
227<pre>void&nbsp;setWeight(double&nbsp;wt)</pre>
228<div class="block">Sets the weigth with which an Objective or Issue is evaluated.</div>
229<dl>
230<dt><span class="paramLabel">Parameters:</span></dt>
231<dd><code>wt</code> - The new weight, a value in [0,1].</dd>
232</dl>
233</li>
234</ul>
235<a name="lockWeight--">
236<!-- -->
237</a>
238<ul class="blockList">
239<li class="blockList">
240<h4>lockWeight</h4>
241<pre>void&nbsp;lockWeight()</pre>
242<div class="block">lockWeight is a flag affecting the behaviour of the normalize function in
243 the utility space. This is used to change behaviour when users drag
244 sliders</div>
245</li>
246</ul>
247<a name="unlockWeight--">
248<!-- -->
249</a>
250<ul class="blockList">
251<li class="blockList">
252<h4>unlockWeight</h4>
253<pre>void&nbsp;unlockWeight()</pre>
254<div class="block">Method to unlock a weight. A weight must be unlocked to modify it.</div>
255</li>
256</ul>
257<a name="weightLocked--">
258<!-- -->
259</a>
260<ul class="blockList">
261<li class="blockList">
262<h4>weightLocked</h4>
263<pre>boolean&nbsp;weightLocked()</pre>
264<dl>
265<dt><span class="returnLabel">Returns:</span></dt>
266<dd>true if weight is locked.</dd>
267</dl>
268</li>
269</ul>
270<a name="getEvaluation-genius.core.utility.AdditiveUtilitySpace-genius.core.Bid-int-">
271<!-- -->
272</a>
273<ul class="blockList">
274<li class="blockList">
275<h4>getEvaluation</h4>
276<pre>java.lang.Double&nbsp;getEvaluation(<a href="../../../genius/core/utility/AdditiveUtilitySpace.html" title="class in genius.core.utility">AdditiveUtilitySpace</a>&nbsp;uspace,
277 <a href="../../../genius/core/Bid.html" title="class in genius.core">Bid</a>&nbsp;bid,
278 int&nbsp;index)</pre>
279<div class="block">This method returns the utility of the value of an issue. Note that the
280 value is not multiplied by the issue weight, and is therefore
281 non-normalized.</div>
282<dl>
283<dt><span class="paramLabel">Parameters:</span></dt>
284<dd><code>uspace</code> - preference profile</dd>
285<dd><code>bid</code> - in which the value is contained.</dd>
286<dd><code>index</code> - unique ID of the issue in the bid for which we want an
287 evaluation.</dd>
288<dt><span class="returnLabel">Returns:</span></dt>
289<dd>utility of the value for an issue, not normalized by the issue
290 weight.</dd>
291</dl>
292</li>
293</ul>
294<a name="getType--">
295<!-- -->
296</a>
297<ul class="blockList">
298<li class="blockList">
299<h4>getType</h4>
300<pre><a href="../../../genius/core/utility/EVALUATORTYPE.html" title="enum in genius.core.utility">EVALUATORTYPE</a>&nbsp;getType()</pre>
301<dl>
302<dt><span class="returnLabel">Returns:</span></dt>
303<dd>type of evaluation function, for example EVALUATORTYPE.LINEAR.</dd>
304</dl>
305</li>
306</ul>
307<a name="loadFromXML-genius.core.xml.SimpleElement-">
308<!-- -->
309</a>
310<ul class="blockList">
311<li class="blockList">
312<h4>loadFromXML</h4>
313<pre>void&nbsp;loadFromXML(<a href="../../../genius/core/xml/SimpleElement.html" title="class in genius.core.xml">SimpleElement</a>&nbsp;pRoot)</pre>
314<div class="block">Load the evaluator from an XML file</div>
315<dl>
316<dt><span class="paramLabel">Parameters:</span></dt>
317<dd><code>pRoot</code> - </dd>
318</dl>
319</li>
320</ul>
321<a name="isComplete-genius.core.issue.Objective-">
322<!-- -->
323</a>
324<ul class="blockList">
325<li class="blockList">
326<h4>isComplete</h4>
327<pre>java.lang.String&nbsp;isComplete(<a href="../../../genius/core/issue/Objective.html" title="class in genius.core.issue">Objective</a>&nbsp;whichObjective)</pre>
328<div class="block">Check whether the evaluator has enough information to make an evaluation.</div>
329<dl>
330<dt><span class="paramLabel">Parameters:</span></dt>
331<dd><code>whichObjective</code> - is the objective/issue to which this evaluator is attached.</dd>
332<dt><span class="returnLabel">Returns:</span></dt>
333<dd>String describing lacking component, or null if the evaluator is
334 complete.</dd>
335</dl>
336</li>
337</ul>
338<a name="clone--">
339<!-- -->
340</a>
341<ul class="blockListLast">
342<li class="blockList">
343<h4>clone</h4>
344<pre><a href="../../../genius/core/utility/Evaluator.html" title="interface in genius.core.utility">Evaluator</a>&nbsp;clone()</pre>
345<dl>
346<dt><span class="returnLabel">Returns:</span></dt>
347<dd>clone of the current object.</dd>
348</dl>
349</li>
350</ul>
351</li>
352</ul>
353</li>
354</ul>
355</div>
356</div>
357<!-- ========= END OF CLASS DATA ========= -->
358<!-- ======= START OF BOTTOM NAVBAR ====== -->
359<div class="bottomNav"><a name="navbar.bottom">
360<!-- -->
361</a>
362<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
363<a name="navbar.bottom.firstrow">
364<!-- -->
365</a>
366<ul class="navList" title="Navigation">
367<li><a href="../../../overview-summary.html">Overview</a></li>
368<li><a href="package-summary.html">Package</a></li>
369<li class="navBarCell1Rev">Class</li>
370<li><a href="class-use/Evaluator.html">Use</a></li>
371<li><a href="package-tree.html">Tree</a></li>
372<li><a href="../../../deprecated-list.html">Deprecated</a></li>
373<li><a href="../../../index-all.html">Index</a></li>
374<li><a href="../../../help-doc.html">Help</a></li>
375</ul>
376</div>
377<div class="subNav">
378<ul class="navList">
379<li><a href="../../../genius/core/utility/EVALFUNCTYPE.html" title="enum in genius.core.utility"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
380<li><a href="../../../genius/core/utility/EvaluatorDiscrete.html" title="class in genius.core.utility"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
381</ul>
382<ul class="navList">
383<li><a href="../../../index.html?genius/core/utility/Evaluator.html" target="_top">Frames</a></li>
384<li><a href="Evaluator.html" target="_top">No&nbsp;Frames</a></li>
385</ul>
386<ul class="navList" id="allclasses_navbar_bottom">
387<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
388</ul>
389<div>
390<script type="text/javascript"><!--
391 allClassesLink = document.getElementById("allclasses_navbar_bottom");
392 if(window==top) {
393 allClassesLink.style.display = "block";
394 }
395 else {
396 allClassesLink.style.display = "none";
397 }
398 //-->
399</script>
400</div>
401<div>
402<ul class="subNavList">
403<li>Summary:&nbsp;</li>
404<li>Nested&nbsp;|&nbsp;</li>
405<li>Field&nbsp;|&nbsp;</li>
406<li>Constr&nbsp;|&nbsp;</li>
407<li><a href="#method.summary">Method</a></li>
408</ul>
409<ul class="subNavList">
410<li>Detail:&nbsp;</li>
411<li>Field&nbsp;|&nbsp;</li>
412<li>Constr&nbsp;|&nbsp;</li>
413<li><a href="#method.detail">Method</a></li>
414</ul>
415</div>
416<a name="skip.navbar.bottom">
417<!-- -->
418</a></div>
419<!-- ======== END OF BOTTOM NAVBAR ======= -->
420</body>
421</html>
Note: See TracBrowser for help on using the repository browser.