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