EvaluatorDiscrete (Genius Core Documentation)

java.lang.Object
- genius.core.utility.EvaluatorDiscrete

All Implemented Interfaces:

Evaluator, java.io.Serializable
```
public class EvaluatorDiscrete
extends java.lang.Object
implements Evaluator
```
This class is used to convert the value of a discrete issue to a utility. This object stores a mapping from each discrete value to a positive double, the evaluation of the value. When a ValueDiscrete is evaluated, there are two possibilities:
- One or more utilities in the map are > 1.0. Then, the evaluation of the value is divided by the highest evaluation in the map.
- All utilities are ≤1.0. Then, the evaluation of the value is the same as the utility stored in the map. This is useful to store absolute utilities, which is needed for example in the PocketNegotiator.
Note that most functions here are working with Integer utilities. This is because we need to stay backwards compatible with older versions of Genius.
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

EvaluatorDiscrete()
Creates a new discrete evaluator with weight 0 and no values.

Constructors
Constructor and Description
`EvaluatorDiscrete()` Creates a new discrete evaluator with weight 0 and no values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEvaluation(ValueDiscrete value, java.lang.Integer evaluation)` Add a new possible value to the issue.
`void`	`clear()` wipe evaluation values.
`EvaluatorDiscrete`	`clone()`
`boolean`	`equals(java.lang.Object obj)`
`java.lang.Double`	`getDoubleValue(ValueDiscrete value)`
`java.lang.Integer`	`getEvalMax()`
`java.lang.Double`	`getEvaluation(AdditiveUtilitySpace uspace, Bid bid, int issueID)` This method returns the utility of the value of an issue.
`java.lang.Double`	`getEvaluation(ValueDiscrete value)`
`java.lang.Integer`	`getEvaluationNotNormalized(Bid bid, int ID)`
`java.lang.Integer`	`getEvaluationNotNormalized(ValueDiscrete value)`
`Value`	`getMaxValue()`
`Value`	`getMinValue()`
`EVALUATORTYPE`	`getType()`
`java.lang.Integer`	`getValue(ValueDiscrete value)`
`java.util.Set<ValueDiscrete>`	`getValues()`
`double`	`getWeight()`
`int`	`hashCode()`
`java.lang.String`	`isComplete(Objective whichobj)` Check whether the evaluator has enough information to make an evaluation.
`void`	`loadFromXML(SimpleElement pRoot)` Loads `fEval` from a SimpleElement containing something like this: `<item index="1" description= "Buy bags of chips and party nuts for all guests." value="Chips and Nuts" cost="100.0" evaluation="3">`.
`void`	`lockWeight()` lockWeight is a flag affecting the behaviour of the normalize function in the utility space.
`java.lang.Double`	`normalize(java.lang.Integer EvalValueL)`
`void`	`setEvaluation(Value val, int evaluation)` Sets the evaluation for Value `val`.
`void`	`setEvaluationDouble(ValueDiscrete val, double evaluation)` identical to `setEvaluation(Value, int)` but accepts double.
`void`	`setWeight(double wt)` Sets the weigth with which an Objective or Issue is evaluated.
`SimpleElement`	`setXML(SimpleElement evalObj)` Sets weights and evaluator properties for the object in SimpleElement representation that is passed to it.
`java.lang.String`	`toString()`
`void`	`unlockWeight()` Method to unlock a weight.
`boolean`	`weightLocked()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EvaluatorDiscrete
```
public EvaluatorDiscrete()
```
    Creates a new discrete evaluator with weight 0 and no values.
- Method Detail
  - getWeight
```
public double getWeight()
```
    Specified by:
    
    getWeight in interface Evaluator
    
    Returns:
    
    the weight associated with this, a value in [0,1]
  - setWeight
```
public void setWeight(double wt)
```
    Description copied from interface: Evaluator
    
    Sets the weigth with which an Objective or Issue is evaluated.
    
    Specified by:
    
    setWeight in interface Evaluator
    
    Parameters:
    
    wt - The new weight, a value in [0,1].
  - lockWeight
```
public void lockWeight()
```
    Description copied from interface: Evaluator
    
    lockWeight is a flag affecting the behaviour of the normalize function in the utility space. This is used to change behaviour when users drag sliders
    
    Specified by:
    
    lockWeight in interface Evaluator
  - unlockWeight
```
public void unlockWeight()
```
    Description copied from interface: Evaluator
    
    Method to unlock a weight. A weight must be unlocked to modify it.
    
    Specified by:
    
    unlockWeight in interface Evaluator
  - weightLocked
```
public boolean weightLocked()
```
    Specified by:
    
    weightLocked in interface Evaluator
    
    Returns:
    
    true if weight is locked.
  - loadFromXML
```
public void loadFromXML(SimpleElement pRoot)
```
    Loads fEval from a SimpleElement containing something like this: <item index="1" description= "Buy bags of chips and party nuts for all guests." value="Chips and Nuts" cost="100.0" evaluation="3">. Only the value and evaluation are used, the rest is ignored. NOTICE: the fWeight of this EvaluatorDiscrete is not set.
    
    Specified by:
    
    loadFromXML in interface Evaluator
  - isComplete
```
public java.lang.String isComplete(Objective whichobj)
```
    Description copied from interface: Evaluator
    
    Check whether the evaluator has enough information to make an evaluation.
    
    Specified by:
    
    isComplete in interface Evaluator
    
    Parameters:
    
    whichobj - is the objective/issue to which this evaluator is attached.
    
    Returns:
    
    String describing lacking component, or null if the evaluator is complete.
  - clone
```
public EvaluatorDiscrete clone()
```
    Specified by:
    
    clone in interface Evaluator
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    clone of the current object.
  - getEvaluation
```
public java.lang.Double getEvaluation(AdditiveUtilitySpace uspace,
                                      Bid bid,
                                      int issueID)
```
    Description copied from interface: Evaluator
    
    This method returns the utility of the value of an issue. Note that the value is not multiplied by the issue weight, and is therefore non-normalized.
    
    Specified by:
    
    getEvaluation in interface Evaluator
    
    Parameters:
    
    uspace - preference profile
    
    bid - in which the value is contained.
    
    issueID - unique ID of the issue in the bid for which we want an evaluation.
    
    Returns:
    
    utility of the value for an issue, not normalized by the issue weight.
  - getValue
```
public java.lang.Integer getValue(ValueDiscrete value)
```
    Parameters:
    
    value - of which the evaluation is requested. ALways returns rounded values, to be compatible with the old version of PN where values could be only integers.
    
    Returns:
    
    the non-normalized evaluation of the given value. The value is rounded to the nearest integer. Returns 0 for values that are not set or unknown.
  - getDoubleValue
```
public java.lang.Double getDoubleValue(ValueDiscrete value)
```
    Parameters:
    
    value -
    
    Returns:
    
    the exact double value/util of a issuevalue
  - getEvalMax
```
public java.lang.Integer getEvalMax()
```
    Returns:
    
    the largest evaluation value available
  - getEvaluation
```
public java.lang.Double getEvaluation(ValueDiscrete value)
                               throws java.lang.Exception
```
    Parameters:
    
    value - of the issue.
    
    Returns:
    
    normalized utility (between [0,1]) of the given value.
    
    Throws:
    
    java.lang.Exception - if value is null.
  - getEvaluationNotNormalized
```
public java.lang.Integer getEvaluationNotNormalized(Bid bid,
                                                    int ID)
                                             throws java.lang.Exception
```
    Parameters:
    
    bid -
    
    ID - of the issue of which we are interested in the value
    
    Returns:
    
    non-normalized evaluation (positive integer) of the given value.
    
    Throws:
    
    java.lang.Exception - if bid or value is null.
  - getEvaluationNotNormalized
```
public java.lang.Integer getEvaluationNotNormalized(ValueDiscrete value)
                                             throws java.lang.Exception
```
    Parameters:
    
    value - of the issue.
    
    Returns:
    
    non-normalized evaluation (positive integer) of the given value. Actually identical to getValue(ValueDiscrete).
    
    Throws:
    
    java.lang.Exception - if value is null.
  - normalize
```
public java.lang.Double normalize(java.lang.Integer EvalValueL)
```
    Parameters:
    
    EvalValueL -
    
    Returns:
    
    normalized EvalValue ASSUMED that Max value is at least 1, because EVERY evaluatordiscrete is at least 1.
  - getType
```
public EVALUATORTYPE getType()
```
    Specified by:
    
    getType in interface Evaluator
    
    Returns:
    
    type of evaluation function, for example EVALUATORTYPE.LINEAR.
  - setEvaluation
```
public void setEvaluation(Value val,
                          int evaluation)
```
    Sets the evaluation for Value val. If this value doesn't exist yet in this Evaluator, adds it as well.
    
    Parameters:
    
    val - The value to add or have its evaluation modified.
    
    evaluation - The new evaluation. only POSITIVE integer values acceptable as evaluation
  - setEvaluationDouble
```
public void setEvaluationDouble(ValueDiscrete val,
                                double evaluation)
```
    identical to setEvaluation(Value, int) but accepts double.
    
    Parameters:
    
    val - The value to add or have its evaluation modified.
    
    evaluation - The new evaluation. only POSITIVE integer values acceptable as evaluation value
  - clear
```
public void clear()
```
    wipe evaluation values.
  - setXML
```
public SimpleElement setXML(SimpleElement evalObj)
```
    Sets weights and evaluator properties for the object in SimpleElement representation that is passed to it.
    
    Parameters:
    
    evalObj - The object of which to set the evaluation properties.
    
    Returns:
    
    The modified simpleElement with all evaluator properties set.
  - addEvaluation
```
public void addEvaluation(ValueDiscrete value,
                          java.lang.Integer evaluation)
```
    Add a new possible value to the issue. Same as setEvaluation(Value, int). To set Double values, use setEvaluationDouble(ValueDiscrete, double).
    
    Parameters:
    
    value - to be added to the issue.
    
    evaluation - of the value.
  - getMaxValue
```
public Value getMaxValue()
```
    Returns:
    
    value with the highest evaluation.
  - getMinValue
```
public Value getMinValue()
```
    Returns:
    
    value with the lowest evaluation.
  - getValues
```
public java.util.Set<ValueDiscrete> getValues()
```
    Returns:
    
    valid values for this issue.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class EvaluatorDiscrete

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EvaluatorDiscrete

Method Detail

getWeight

setWeight

lockWeight

unlockWeight

weightLocked

loadFromXML

isComplete

clone

getEvaluation

getValue

getDoubleValue

getEvalMax

getEvaluation

getEvaluationNotNormalized

getEvaluationNotNormalized

normalize

getType

setEvaluation

setEvaluationDouble

clear

setXML

addEvaluation

getMaxValue

getMinValue

getValues

hashCode

equals

toString