source: javadoc/genius/core/utility/EvaluatorInteger.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: 34.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:58 CEST 2018 -->
6<title>EvaluatorInteger (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="EvaluatorInteger (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,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":42,"i16":10,"i17":42,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10};
22var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/EvaluatorInteger.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/EvaluatorDiscrete.html" title="class in genius.core.utility"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
53<li><a href="../../../genius/core/utility/EvaluatorObjective.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/EvaluatorInteger.html" target="_top">Frames</a></li>
57<li><a href="EvaluatorInteger.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 EvaluatorInteger" class="title">Class EvaluatorInteger</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.EvaluatorInteger</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><a href="../../../genius/core/utility/Evaluator.html" title="interface in genius.core.utility">Evaluator</a>, java.io.Serializable</dd>
113</dl>
114<hr>
115<br>
116<pre>public class <span class="typeNameLabel">EvaluatorInteger</span>
117extends java.lang.Object
118implements <a href="../../../genius/core/utility/Evaluator.html" title="interface in genius.core.utility">Evaluator</a></pre>
119<div class="block">This class is used to convert the value of an integer issue to a utility.
120 This object stores the range of the issue and a linear function mapping each
121 value to a utility. Note that this utility is not yet normalized by the issue
122 weight and is therefore in the range [0,1].</div>
123<dl>
124<dt><span class="seeLabel">See Also:</span></dt>
125<dd><a href="../../../serialized-form.html#genius.core.utility.EvaluatorInteger">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/utility/EvaluatorInteger.html#EvaluatorInteger--">EvaluatorInteger</a></span>()</code>
146<div class="block">Creates a new integer evaluator with weight 0 and no values.</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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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><a href="../../../genius/core/utility/EvaluatorInteger.html" title="class in genius.core.utility">EvaluatorInteger</a></code></td>
166<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/EvaluatorInteger.html#clone--">clone</a></span>()</code>&nbsp;</td>
167</tr>
168<tr id="i1" class="rowColor">
169<td class="colFirst"><code>java.lang.Double</code></td>
170<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/EvaluatorInteger.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,
171 <a href="../../../genius/core/Bid.html" title="class in genius.core">Bid</a>&nbsp;bid,
172 int&nbsp;index)</code>
173<div class="block">This method returns the utility of the value of an issue.</div>
174</td>
175</tr>
176<tr id="i2" class="altColor">
177<td class="colFirst"><code>java.lang.Double</code></td>
178<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/EvaluatorInteger.html#getEvaluation-int-">getEvaluation</a></span>(int&nbsp;value)</code>&nbsp;</td>
179</tr>
180<tr id="i3" class="rowColor">
181<td class="colFirst"><code><a href="../../../genius/core/utility/EVALFUNCTYPE.html" title="enum in genius.core.utility">EVALFUNCTYPE</a></code></td>
182<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/EvaluatorInteger.html#getFuncType--">getFuncType</a></span>()</code>&nbsp;</td>
183</tr>
184<tr id="i4" class="altColor">
185<td class="colFirst"><code>int</code></td>
186<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/EvaluatorInteger.html#getLowerBound--">getLowerBound</a></span>()</code>&nbsp;</td>
187</tr>
188<tr id="i5" class="rowColor">
189<td class="colFirst"><code>double</code></td>
190<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/EvaluatorInteger.html#getOffset--">getOffset</a></span>()</code>&nbsp;</td>
191</tr>
192<tr id="i6" class="altColor">
193<td class="colFirst"><code>double</code></td>
194<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/EvaluatorInteger.html#getSlope--">getSlope</a></span>()</code>&nbsp;</td>
195</tr>
196<tr id="i7" class="rowColor">
197<td class="colFirst"><code><a href="../../../genius/core/utility/EVALUATORTYPE.html" title="enum in genius.core.utility">EVALUATORTYPE</a></code></td>
198<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/EvaluatorInteger.html#getType--">getType</a></span>()</code>&nbsp;</td>
199</tr>
200<tr id="i8" class="altColor">
201<td class="colFirst"><code>int</code></td>
202<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/EvaluatorInteger.html#getUpperBound--">getUpperBound</a></span>()</code>&nbsp;</td>
203</tr>
204<tr id="i9" class="rowColor">
205<td class="colFirst"><code>double</code></td>
206<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/EvaluatorInteger.html#getUtilHighestValue--">getUtilHighestValue</a></span>()</code>&nbsp;</td>
207</tr>
208<tr id="i10" class="altColor">
209<td class="colFirst"><code>double</code></td>
210<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/EvaluatorInteger.html#getUtilLowestValue--">getUtilLowestValue</a></span>()</code>&nbsp;</td>
211</tr>
212<tr id="i11" class="rowColor">
213<td class="colFirst"><code>double</code></td>
214<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/EvaluatorInteger.html#getWeight--">getWeight</a></span>()</code>&nbsp;</td>
215</tr>
216<tr id="i12" class="altColor">
217<td class="colFirst"><code>java.lang.String</code></td>
218<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/EvaluatorInteger.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;whichobj)</code>
219<div class="block">Check whether the evaluator has enough information to make an evaluation.</div>
220</td>
221</tr>
222<tr id="i13" class="rowColor">
223<td class="colFirst"><code>void</code></td>
224<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/EvaluatorInteger.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>
225<div class="block">Load the evaluator from an XML file</div>
226</td>
227</tr>
228<tr id="i14" class="altColor">
229<td class="colFirst"><code>void</code></td>
230<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/EvaluatorInteger.html#lockWeight--">lockWeight</a></span>()</code>
231<div class="block">lockWeight is a flag affecting the behaviour of the normalize function in
232 the utility space.</div>
233</td>
234</tr>
235<tr id="i15" class="rowColor">
236<td class="colFirst"><code>void</code></td>
237<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/EvaluatorInteger.html#setConstantParam-double-">setConstantParam</a></span>(double&nbsp;offset)</code>
238<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
239</td>
240</tr>
241<tr id="i16" class="altColor">
242<td class="colFirst"><code>void</code></td>
243<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/EvaluatorInteger.html#setLinearFunction-double-double-">setLinearFunction</a></span>(double&nbsp;utilLowInt,
244 double&nbsp;utilHighInt)</code>
245<div class="block">Specifies the linear utility function of the issue by giving the utility
246 of the lowest value and the highest value.</div>
247</td>
248</tr>
249<tr id="i17" class="rowColor">
250<td class="colFirst"><code>void</code></td>
251<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/EvaluatorInteger.html#setLinearParam-double-">setLinearParam</a></span>(double&nbsp;slope)</code>
252<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
253</td>
254</tr>
255<tr id="i18" class="altColor">
256<td class="colFirst"><code>void</code></td>
257<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/EvaluatorInteger.html#setLowerBound-int-">setLowerBound</a></span>(int&nbsp;lb)</code>
258<div class="block">Sets the lower bound of this evaluator.</div>
259</td>
260</tr>
261<tr id="i19" class="rowColor">
262<td class="colFirst"><code>void</code></td>
263<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/EvaluatorInteger.html#setOffset-double-">setOffset</a></span>(double&nbsp;offset)</code>
264<div class="block">Sets the offset of the linear utility function.</div>
265</td>
266</tr>
267<tr id="i20" class="altColor">
268<td class="colFirst"><code>void</code></td>
269<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/EvaluatorInteger.html#setSlope-double-">setSlope</a></span>(double&nbsp;slope)</code>
270<div class="block">Sets the slope of the linear utility function.</div>
271</td>
272</tr>
273<tr id="i21" class="rowColor">
274<td class="colFirst"><code>void</code></td>
275<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/EvaluatorInteger.html#setUpperBound-int-">setUpperBound</a></span>(int&nbsp;ub)</code>
276<div class="block">Sets the upper bound of this evaluator.</div>
277</td>
278</tr>
279<tr id="i22" class="altColor">
280<td class="colFirst"><code>void</code></td>
281<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/EvaluatorInteger.html#setWeight-double-">setWeight</a></span>(double&nbsp;wt)</code>
282<div class="block">Sets the weigth with which an Objective or Issue is evaluated.</div>
283</td>
284</tr>
285<tr id="i23" class="rowColor">
286<td class="colFirst"><code><a href="../../../genius/core/xml/SimpleElement.html" title="class in genius.core.xml">SimpleElement</a></code></td>
287<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/EvaluatorInteger.html#setXML-genius.core.xml.SimpleElement-">setXML</a></span>(<a href="../../../genius/core/xml/SimpleElement.html" title="class in genius.core.xml">SimpleElement</a>&nbsp;evalObj)</code>
288<div class="block">Sets weights and evaluator properties for the object in SimpleElement
289 representation that is passed to it.</div>
290</td>
291</tr>
292<tr id="i24" class="altColor">
293<td class="colFirst"><code>java.lang.String</code></td>
294<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/EvaluatorInteger.html#toString--">toString</a></span>()</code>&nbsp;</td>
295</tr>
296<tr id="i25" class="rowColor">
297<td class="colFirst"><code>void</code></td>
298<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/EvaluatorInteger.html#unlockWeight--">unlockWeight</a></span>()</code>
299<div class="block">Method to unlock a weight.</div>
300</td>
301</tr>
302<tr id="i26" class="altColor">
303<td class="colFirst"><code>boolean</code></td>
304<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/utility/EvaluatorInteger.html#weightLocked--">weightLocked</a></span>()</code>&nbsp;</td>
305</tr>
306</table>
307<ul class="blockList">
308<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
309<!-- -->
310</a>
311<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
312<code>equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
313</ul>
314</li>
315</ul>
316</li>
317</ul>
318</div>
319<div class="details">
320<ul class="blockList">
321<li class="blockList">
322<!-- ========= CONSTRUCTOR DETAIL ======== -->
323<ul class="blockList">
324<li class="blockList"><a name="constructor.detail">
325<!-- -->
326</a>
327<h3>Constructor Detail</h3>
328<a name="EvaluatorInteger--">
329<!-- -->
330</a>
331<ul class="blockListLast">
332<li class="blockList">
333<h4>EvaluatorInteger</h4>
334<pre>public&nbsp;EvaluatorInteger()</pre>
335<div class="block">Creates a new integer evaluator with weight 0 and no values.</div>
336</li>
337</ul>
338</li>
339</ul>
340<!-- ============ METHOD DETAIL ========== -->
341<ul class="blockList">
342<li class="blockList"><a name="method.detail">
343<!-- -->
344</a>
345<h3>Method Detail</h3>
346<a name="getWeight--">
347<!-- -->
348</a>
349<ul class="blockList">
350<li class="blockList">
351<h4>getWeight</h4>
352<pre>public&nbsp;double&nbsp;getWeight()</pre>
353<dl>
354<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
355<dd><code><a href="../../../genius/core/utility/Evaluator.html#getWeight--">getWeight</a></code>&nbsp;in interface&nbsp;<code><a href="../../../genius/core/utility/Evaluator.html" title="interface in genius.core.utility">Evaluator</a></code></dd>
356<dt><span class="returnLabel">Returns:</span></dt>
357<dd>the weight associated with this, a value in [0,1]</dd>
358</dl>
359</li>
360</ul>
361<a name="setWeight-double-">
362<!-- -->
363</a>
364<ul class="blockList">
365<li class="blockList">
366<h4>setWeight</h4>
367<pre>public&nbsp;void&nbsp;setWeight(double&nbsp;wt)</pre>
368<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../genius/core/utility/Evaluator.html#setWeight-double-">Evaluator</a></code></span></div>
369<div class="block">Sets the weigth with which an Objective or Issue is evaluated.</div>
370<dl>
371<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
372<dd><code><a href="../../../genius/core/utility/Evaluator.html#setWeight-double-">setWeight</a></code>&nbsp;in interface&nbsp;<code><a href="../../../genius/core/utility/Evaluator.html" title="interface in genius.core.utility">Evaluator</a></code></dd>
373<dt><span class="paramLabel">Parameters:</span></dt>
374<dd><code>wt</code> - The new weight, a value in [0,1].</dd>
375</dl>
376</li>
377</ul>
378<a name="lockWeight--">
379<!-- -->
380</a>
381<ul class="blockList">
382<li class="blockList">
383<h4>lockWeight</h4>
384<pre>public&nbsp;void&nbsp;lockWeight()</pre>
385<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../genius/core/utility/Evaluator.html#lockWeight--">Evaluator</a></code></span></div>
386<div class="block">lockWeight is a flag affecting the behaviour of the normalize function in
387 the utility space. This is used to change behaviour when users drag
388 sliders</div>
389<dl>
390<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
391<dd><code><a href="../../../genius/core/utility/Evaluator.html#lockWeight--">lockWeight</a></code>&nbsp;in interface&nbsp;<code><a href="../../../genius/core/utility/Evaluator.html" title="interface in genius.core.utility">Evaluator</a></code></dd>
392</dl>
393</li>
394</ul>
395<a name="unlockWeight--">
396<!-- -->
397</a>
398<ul class="blockList">
399<li class="blockList">
400<h4>unlockWeight</h4>
401<pre>public&nbsp;void&nbsp;unlockWeight()</pre>
402<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../genius/core/utility/Evaluator.html#unlockWeight--">Evaluator</a></code></span></div>
403<div class="block">Method to unlock a weight. A weight must be unlocked to modify it.</div>
404<dl>
405<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
406<dd><code><a href="../../../genius/core/utility/Evaluator.html#unlockWeight--">unlockWeight</a></code>&nbsp;in interface&nbsp;<code><a href="../../../genius/core/utility/Evaluator.html" title="interface in genius.core.utility">Evaluator</a></code></dd>
407</dl>
408</li>
409</ul>
410<a name="weightLocked--">
411<!-- -->
412</a>
413<ul class="blockList">
414<li class="blockList">
415<h4>weightLocked</h4>
416<pre>public&nbsp;boolean&nbsp;weightLocked()</pre>
417<dl>
418<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
419<dd><code><a href="../../../genius/core/utility/Evaluator.html#weightLocked--">weightLocked</a></code>&nbsp;in interface&nbsp;<code><a href="../../../genius/core/utility/Evaluator.html" title="interface in genius.core.utility">Evaluator</a></code></dd>
420<dt><span class="returnLabel">Returns:</span></dt>
421<dd>true if weight is locked.</dd>
422</dl>
423</li>
424</ul>
425<a name="getEvaluation-genius.core.utility.AdditiveUtilitySpace-genius.core.Bid-int-">
426<!-- -->
427</a>
428<ul class="blockList">
429<li class="blockList">
430<h4>getEvaluation</h4>
431<pre>public&nbsp;java.lang.Double&nbsp;getEvaluation(<a href="../../../genius/core/utility/AdditiveUtilitySpace.html" title="class in genius.core.utility">AdditiveUtilitySpace</a>&nbsp;uspace,
432 <a href="../../../genius/core/Bid.html" title="class in genius.core">Bid</a>&nbsp;bid,
433 int&nbsp;index)</pre>
434<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../genius/core/utility/Evaluator.html#getEvaluation-genius.core.utility.AdditiveUtilitySpace-genius.core.Bid-int-">Evaluator</a></code></span></div>
435<div class="block">This method returns the utility of the value of an issue. Note that the
436 value is not multiplied by the issue weight, and is therefore
437 non-normalized.</div>
438<dl>
439<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
440<dd><code><a href="../../../genius/core/utility/Evaluator.html#getEvaluation-genius.core.utility.AdditiveUtilitySpace-genius.core.Bid-int-">getEvaluation</a></code>&nbsp;in interface&nbsp;<code><a href="../../../genius/core/utility/Evaluator.html" title="interface in genius.core.utility">Evaluator</a></code></dd>
441<dt><span class="paramLabel">Parameters:</span></dt>
442<dd><code>uspace</code> - preference profile</dd>
443<dd><code>bid</code> - in which the value is contained.</dd>
444<dd><code>index</code> - unique ID of the issue in the bid for which we want an
445 evaluation.</dd>
446<dt><span class="returnLabel">Returns:</span></dt>
447<dd>utility of the value for an issue, not normalized by the issue
448 weight.</dd>
449</dl>
450</li>
451</ul>
452<a name="getType--">
453<!-- -->
454</a>
455<ul class="blockList">
456<li class="blockList">
457<h4>getType</h4>
458<pre>public&nbsp;<a href="../../../genius/core/utility/EVALUATORTYPE.html" title="enum in genius.core.utility">EVALUATORTYPE</a>&nbsp;getType()</pre>
459<dl>
460<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
461<dd><code><a href="../../../genius/core/utility/Evaluator.html#getType--">getType</a></code>&nbsp;in interface&nbsp;<code><a href="../../../genius/core/utility/Evaluator.html" title="interface in genius.core.utility">Evaluator</a></code></dd>
462<dt><span class="returnLabel">Returns:</span></dt>
463<dd>type of evaluation function, for example EVALUATORTYPE.LINEAR.</dd>
464</dl>
465</li>
466</ul>
467<a name="loadFromXML-genius.core.xml.SimpleElement-">
468<!-- -->
469</a>
470<ul class="blockList">
471<li class="blockList">
472<h4>loadFromXML</h4>
473<pre>public&nbsp;void&nbsp;loadFromXML(<a href="../../../genius/core/xml/SimpleElement.html" title="class in genius.core.xml">SimpleElement</a>&nbsp;pRoot)</pre>
474<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../genius/core/utility/Evaluator.html#loadFromXML-genius.core.xml.SimpleElement-">Evaluator</a></code></span></div>
475<div class="block">Load the evaluator from an XML file</div>
476<dl>
477<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
478<dd><code><a href="../../../genius/core/utility/Evaluator.html#loadFromXML-genius.core.xml.SimpleElement-">loadFromXML</a></code>&nbsp;in interface&nbsp;<code><a href="../../../genius/core/utility/Evaluator.html" title="interface in genius.core.utility">Evaluator</a></code></dd>
479</dl>
480</li>
481</ul>
482<a name="toString--">
483<!-- -->
484</a>
485<ul class="blockList">
486<li class="blockList">
487<h4>toString</h4>
488<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
489<dl>
490<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
491<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
492</dl>
493</li>
494</ul>
495<a name="isComplete-genius.core.issue.Objective-">
496<!-- -->
497</a>
498<ul class="blockList">
499<li class="blockList">
500<h4>isComplete</h4>
501<pre>public&nbsp;java.lang.String&nbsp;isComplete(<a href="../../../genius/core/issue/Objective.html" title="class in genius.core.issue">Objective</a>&nbsp;whichobj)</pre>
502<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../genius/core/utility/Evaluator.html#isComplete-genius.core.issue.Objective-">Evaluator</a></code></span></div>
503<div class="block">Check whether the evaluator has enough information to make an evaluation.</div>
504<dl>
505<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
506<dd><code><a href="../../../genius/core/utility/Evaluator.html#isComplete-genius.core.issue.Objective-">isComplete</a></code>&nbsp;in interface&nbsp;<code><a href="../../../genius/core/utility/Evaluator.html" title="interface in genius.core.utility">Evaluator</a></code></dd>
507<dt><span class="paramLabel">Parameters:</span></dt>
508<dd><code>whichobj</code> - is the objective/issue to which this evaluator is attached.</dd>
509<dt><span class="returnLabel">Returns:</span></dt>
510<dd>String describing lacking component, or null if the evaluator is
511 complete.</dd>
512</dl>
513</li>
514</ul>
515<a name="getEvaluation-int-">
516<!-- -->
517</a>
518<ul class="blockList">
519<li class="blockList">
520<h4>getEvaluation</h4>
521<pre>public&nbsp;java.lang.Double&nbsp;getEvaluation(int&nbsp;value)</pre>
522<dl>
523<dt><span class="paramLabel">Parameters:</span></dt>
524<dd><code>value</code> - of an issue.</dd>
525<dt><span class="returnLabel">Returns:</span></dt>
526<dd>utility of the given value (range: [0,1]).</dd>
527</dl>
528</li>
529</ul>
530<a name="getFuncType--">
531<!-- -->
532</a>
533<ul class="blockList">
534<li class="blockList">
535<h4>getFuncType</h4>
536<pre>public&nbsp;<a href="../../../genius/core/utility/EVALFUNCTYPE.html" title="enum in genius.core.utility">EVALFUNCTYPE</a>&nbsp;getFuncType()</pre>
537<dl>
538<dt><span class="returnLabel">Returns:</span></dt>
539<dd>evaluation function type.</dd>
540</dl>
541</li>
542</ul>
543<a name="getLowerBound--">
544<!-- -->
545</a>
546<ul class="blockList">
547<li class="blockList">
548<h4>getLowerBound</h4>
549<pre>public&nbsp;int&nbsp;getLowerBound()</pre>
550<dl>
551<dt><span class="returnLabel">Returns:</span></dt>
552<dd>lowerbound of the integer issue.</dd>
553</dl>
554</li>
555</ul>
556<a name="getUpperBound--">
557<!-- -->
558</a>
559<ul class="blockList">
560<li class="blockList">
561<h4>getUpperBound</h4>
562<pre>public&nbsp;int&nbsp;getUpperBound()</pre>
563<dl>
564<dt><span class="returnLabel">Returns:</span></dt>
565<dd>higherbound of the integer issue.</dd>
566</dl>
567</li>
568</ul>
569<a name="getUtilLowestValue--">
570<!-- -->
571</a>
572<ul class="blockList">
573<li class="blockList">
574<h4>getUtilLowestValue</h4>
575<pre>public&nbsp;double&nbsp;getUtilLowestValue()</pre>
576<dl>
577<dt><span class="returnLabel">Returns:</span></dt>
578<dd>lowest possible utility value.</dd>
579</dl>
580</li>
581</ul>
582<a name="getUtilHighestValue--">
583<!-- -->
584</a>
585<ul class="blockList">
586<li class="blockList">
587<h4>getUtilHighestValue</h4>
588<pre>public&nbsp;double&nbsp;getUtilHighestValue()</pre>
589<dl>
590<dt><span class="returnLabel">Returns:</span></dt>
591<dd>highest possible utility value.</dd>
592</dl>
593</li>
594</ul>
595<a name="setLowerBound-int-">
596<!-- -->
597</a>
598<ul class="blockList">
599<li class="blockList">
600<h4>setLowerBound</h4>
601<pre>public&nbsp;void&nbsp;setLowerBound(int&nbsp;lb)</pre>
602<div class="block">Sets the lower bound of this evaluator.</div>
603<dl>
604<dt><span class="paramLabel">Parameters:</span></dt>
605<dd><code>lb</code> - The new lower bound</dd>
606</dl>
607</li>
608</ul>
609<a name="setUpperBound-int-">
610<!-- -->
611</a>
612<ul class="blockList">
613<li class="blockList">
614<h4>setUpperBound</h4>
615<pre>public&nbsp;void&nbsp;setUpperBound(int&nbsp;ub)</pre>
616<div class="block">Sets the upper bound of this evaluator.</div>
617<dl>
618<dt><span class="paramLabel">Parameters:</span></dt>
619<dd><code>ub</code> - The new upper bound</dd>
620</dl>
621</li>
622</ul>
623<a name="setLinearFunction-double-double-">
624<!-- -->
625</a>
626<ul class="blockList">
627<li class="blockList">
628<h4>setLinearFunction</h4>
629<pre>public&nbsp;void&nbsp;setLinearFunction(double&nbsp;utilLowInt,
630 double&nbsp;utilHighInt)</pre>
631<div class="block">Specifies the linear utility function of the issue by giving the utility
632 of the lowest value and the highest value.</div>
633<dl>
634<dt><span class="paramLabel">Parameters:</span></dt>
635<dd><code>utilLowInt</code> - utility of the lowest vale.</dd>
636<dd><code>utilHighInt</code> - utility of the highest value.</dd>
637</dl>
638</li>
639</ul>
640<a name="setXML-genius.core.xml.SimpleElement-">
641<!-- -->
642</a>
643<ul class="blockList">
644<li class="blockList">
645<h4>setXML</h4>
646<pre>public&nbsp;<a href="../../../genius/core/xml/SimpleElement.html" title="class in genius.core.xml">SimpleElement</a>&nbsp;setXML(<a href="../../../genius/core/xml/SimpleElement.html" title="class in genius.core.xml">SimpleElement</a>&nbsp;evalObj)</pre>
647<div class="block">Sets weights and evaluator properties for the object in SimpleElement
648 representation that is passed to it.</div>
649<dl>
650<dt><span class="paramLabel">Parameters:</span></dt>
651<dd><code>evalObj</code> - The object of which to set the evaluation properties.</dd>
652<dt><span class="returnLabel">Returns:</span></dt>
653<dd>The modified simpleElement with all evaluator properties set.</dd>
654</dl>
655</li>
656</ul>
657<a name="getSlope--">
658<!-- -->
659</a>
660<ul class="blockList">
661<li class="blockList">
662<h4>getSlope</h4>
663<pre>public&nbsp;double&nbsp;getSlope()</pre>
664<dl>
665<dt><span class="returnLabel">Returns:</span></dt>
666<dd>slope of the linear utility function.</dd>
667</dl>
668</li>
669</ul>
670<a name="setSlope-double-">
671<!-- -->
672</a>
673<ul class="blockList">
674<li class="blockList">
675<h4>setSlope</h4>
676<pre>public&nbsp;void&nbsp;setSlope(double&nbsp;slope)</pre>
677<div class="block">Sets the slope of the linear utility function.</div>
678<dl>
679<dt><span class="paramLabel">Parameters:</span></dt>
680<dd><code>slope</code> - of the linear utility function.</dd>
681</dl>
682</li>
683</ul>
684<a name="setLinearParam-double-">
685<!-- -->
686</a>
687<ul class="blockList">
688<li class="blockList">
689<h4>setLinearParam</h4>
690<pre>@Deprecated
691public&nbsp;void&nbsp;setLinearParam(double&nbsp;slope)</pre>
692<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
693<div class="block">Sets the slope of the linear utility function.</div>
694<dl>
695<dt><span class="paramLabel">Parameters:</span></dt>
696<dd><code>slope</code> - of the linear utility function.</dd>
697</dl>
698</li>
699</ul>
700<a name="getOffset--">
701<!-- -->
702</a>
703<ul class="blockList">
704<li class="blockList">
705<h4>getOffset</h4>
706<pre>public&nbsp;double&nbsp;getOffset()</pre>
707<dl>
708<dt><span class="returnLabel">Returns:</span></dt>
709<dd>offset of the linear utility function.</dd>
710</dl>
711</li>
712</ul>
713<a name="setOffset-double-">
714<!-- -->
715</a>
716<ul class="blockList">
717<li class="blockList">
718<h4>setOffset</h4>
719<pre>public&nbsp;void&nbsp;setOffset(double&nbsp;offset)</pre>
720<div class="block">Sets the offset of the linear utility function.</div>
721<dl>
722<dt><span class="paramLabel">Parameters:</span></dt>
723<dd><code>offset</code> - of the linear utility function.</dd>
724</dl>
725</li>
726</ul>
727<a name="setConstantParam-double-">
728<!-- -->
729</a>
730<ul class="blockList">
731<li class="blockList">
732<h4>setConstantParam</h4>
733<pre>@Deprecated
734public&nbsp;void&nbsp;setConstantParam(double&nbsp;offset)</pre>
735<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
736<div class="block">Sets the offset of the linear utility function.</div>
737<dl>
738<dt><span class="paramLabel">Parameters:</span></dt>
739<dd><code>offset</code> - of the linear utility function.</dd>
740</dl>
741</li>
742</ul>
743<a name="clone--">
744<!-- -->
745</a>
746<ul class="blockListLast">
747<li class="blockList">
748<h4>clone</h4>
749<pre>public&nbsp;<a href="../../../genius/core/utility/EvaluatorInteger.html" title="class in genius.core.utility">EvaluatorInteger</a>&nbsp;clone()</pre>
750<dl>
751<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
752<dd><code><a href="../../../genius/core/utility/Evaluator.html#clone--">clone</a></code>&nbsp;in interface&nbsp;<code><a href="../../../genius/core/utility/Evaluator.html" title="interface in genius.core.utility">Evaluator</a></code></dd>
753<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
754<dd><code>clone</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
755<dt><span class="returnLabel">Returns:</span></dt>
756<dd>clone of the current object.</dd>
757</dl>
758</li>
759</ul>
760</li>
761</ul>
762</li>
763</ul>
764</div>
765</div>
766<!-- ========= END OF CLASS DATA ========= -->
767<!-- ======= START OF BOTTOM NAVBAR ====== -->
768<div class="bottomNav"><a name="navbar.bottom">
769<!-- -->
770</a>
771<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
772<a name="navbar.bottom.firstrow">
773<!-- -->
774</a>
775<ul class="navList" title="Navigation">
776<li><a href="../../../overview-summary.html">Overview</a></li>
777<li><a href="package-summary.html">Package</a></li>
778<li class="navBarCell1Rev">Class</li>
779<li><a href="class-use/EvaluatorInteger.html">Use</a></li>
780<li><a href="package-tree.html">Tree</a></li>
781<li><a href="../../../deprecated-list.html">Deprecated</a></li>
782<li><a href="../../../index-all.html">Index</a></li>
783<li><a href="../../../help-doc.html">Help</a></li>
784</ul>
785</div>
786<div class="subNav">
787<ul class="navList">
788<li><a href="../../../genius/core/utility/EvaluatorDiscrete.html" title="class in genius.core.utility"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
789<li><a href="../../../genius/core/utility/EvaluatorObjective.html" title="class in genius.core.utility"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
790</ul>
791<ul class="navList">
792<li><a href="../../../index.html?genius/core/utility/EvaluatorInteger.html" target="_top">Frames</a></li>
793<li><a href="EvaluatorInteger.html" target="_top">No&nbsp;Frames</a></li>
794</ul>
795<ul class="navList" id="allclasses_navbar_bottom">
796<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
797</ul>
798<div>
799<script type="text/javascript"><!--
800 allClassesLink = document.getElementById("allclasses_navbar_bottom");
801 if(window==top) {
802 allClassesLink.style.display = "block";
803 }
804 else {
805 allClassesLink.style.display = "none";
806 }
807 //-->
808</script>
809</div>
810<div>
811<ul class="subNavList">
812<li>Summary:&nbsp;</li>
813<li>Nested&nbsp;|&nbsp;</li>
814<li>Field&nbsp;|&nbsp;</li>
815<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
816<li><a href="#method.summary">Method</a></li>
817</ul>
818<ul class="subNavList">
819<li>Detail:&nbsp;</li>
820<li>Field&nbsp;|&nbsp;</li>
821<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
822<li><a href="#method.detail">Method</a></li>
823</ul>
824</div>
825<a name="skip.navbar.bottom">
826<!-- -->
827</a></div>
828<!-- ======== END OF BOTTOM NAVBAR ======= -->
829</body>
830</html>
Note: See TracBrowser for help on using the repository browser.