genius.core.utility

Class EvaluatorInteger

java.lang.Object

genius.core.utility.EvaluatorInteger

All Implemented Interfaces:

Evaluator, java.io.Serializable

public class EvaluatorInteger
extends java.lang.Object
implements Evaluator

This class is used to convert the value of an integer issue to a utility. This object stores the range of the issue and a linear function mapping each value to a utility. Note that this utility is not yet normalized by the issue weight and is therefore in the range [0,1].

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EvaluatorInteger() Creates a new integer evaluator with weight 0 and no values.

Method Summary

Modifier and Type	Method and Description
EvaluatorInteger	clone()
java.lang.Double	getEvaluation(AdditiveUtilitySpace uspace, Bid bid, int index) This method returns the utility of the value of an issue.
java.lang.Double	getEvaluation(int value)
EVALFUNCTYPE	getFuncType()
int	getLowerBound()
double	getOffset()
double	getSlope()
EVALUATORTYPE	getType()
int	getUpperBound()
double	getUtilHighestValue()
double	getUtilLowestValue()
double	getWeight()
java.lang.String	isComplete(Objective whichobj) Check whether the evaluator has enough information to make an evaluation.
void	loadFromXML(SimpleElement pRoot) Load the evaluator from an XML file
void	lockWeight() lockWeight is a flag affecting the behaviour of the normalize function in the utility space.
void	setConstantParam(double offset) Deprecated.
void	setLinearFunction(double utilLowInt, double utilHighInt) Specifies the linear utility function of the issue by giving the utility of the lowest value and the highest value.
void	setLinearParam(double slope) Deprecated.
void	setLowerBound(int lb) Sets the lower bound of this evaluator.
void	setOffset(double offset) Sets the offset of the linear utility function.
void	setSlope(double slope) Sets the slope of the linear utility function.
void	setUpperBound(int ub) Sets the upper bound of this evaluator.
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

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EvaluatorInteger

public EvaluatorInteger()

Creates a new integer 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.

getEvaluation

public java.lang.Double getEvaluation(AdditiveUtilitySpace uspace,
                                      Bid bid,
                                      int index)

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.

index - 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.

getType

public EVALUATORTYPE getType()

Specified by:

getType in interface Evaluator

Returns:

type of evaluation function, for example EVALUATORTYPE.LINEAR.

loadFromXML

public void loadFromXML(SimpleElement pRoot)

Description copied from interface: Evaluator

Load the evaluator from an XML file

Specified by:

loadFromXML in interface Evaluator

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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.

getEvaluation

public java.lang.Double getEvaluation(int value)

Parameters:

value - of an issue.

Returns:

utility of the given value (range: [0,1]).

getFuncType

public EVALFUNCTYPE getFuncType()

Returns:

evaluation function type.

getLowerBound

public int getLowerBound()

Returns:

lowerbound of the integer issue.

getUpperBound

public int getUpperBound()

Returns:

higherbound of the integer issue.

getUtilLowestValue

public double getUtilLowestValue()

Returns:

lowest possible utility value.

getUtilHighestValue

public double getUtilHighestValue()

Returns:

highest possible utility value.

setLowerBound

public void setLowerBound(int lb)

Sets the lower bound of this evaluator.

Parameters:

lb - The new lower bound

setUpperBound

public void setUpperBound(int ub)

Sets the upper bound of this evaluator.

Parameters:

ub - The new upper bound

setLinearFunction

public void setLinearFunction(double utilLowInt,
                              double utilHighInt)

Specifies the linear utility function of the issue by giving the utility of the lowest value and the highest value.

Parameters:

utilLowInt - utility of the lowest vale.

utilHighInt - utility of the highest value.

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.

getSlope

public double getSlope()

Returns:

slope of the linear utility function.

setSlope

public void setSlope(double slope)

Sets the slope of the linear utility function.

Parameters:

slope - of the linear utility function.

setLinearParam

@Deprecated
public void setLinearParam(double slope)

Deprecated.

Sets the slope of the linear utility function.

Parameters:

slope - of the linear utility function.

getOffset

public double getOffset()

Returns:

offset of the linear utility function.

setOffset

public void setOffset(double offset)

Sets the offset of the linear utility function.

Parameters:

offset - of the linear utility function.

setConstantParam

@Deprecated
public void setConstantParam(double offset)

Deprecated.

Sets the offset of the linear utility function.

Parameters:

offset - of the linear utility function.

clone

public EvaluatorInteger clone()

Specified by:

clone in interface Evaluator

Overrides:

clone in class java.lang.Object

Returns:

clone of the current object.