genius.core.utility

Class AdditiveUtilitySpace

java.lang.Object

genius.core.utility.AbstractUtilitySpace

genius.core.utility.AdditiveUtilitySpace

All Implemented Interfaces:

UtilitySpace, java.io.Serializable

Direct Known Subclasses:

AdditiveUtilitySpaceWithPerturbation

public class AdditiveUtilitySpace
extends AbstractUtilitySpace

The additive utility space couples all objectives to weights and evaluators.

Author:

D. Tykhonov, K. Hindriks, W. Pasman

See Also:

Serialized Form

Field Summary

Fields inherited from class genius.core.utility.AbstractUtilitySpace

DISCOUNT_FACTOR, fileName, RESERVATION

Constructor Summary

Constructors

Constructor and Description
AdditiveUtilitySpace() Creates an empty utility space.
AdditiveUtilitySpace(AdditiveUtilitySpace us) Copies the data from another UtilitySpace.
AdditiveUtilitySpace(Domain domain) Creates a new utilityspace of the given domain.
AdditiveUtilitySpace(Domain domain, java.util.Map<Objective,Evaluator> fEvaluators)
AdditiveUtilitySpace(Domain domain, java.lang.String fileName) Create new default util space for a given domain.

Method Summary

Modifier and Type	Method and Description
Evaluator	addEvaluator(Objective obj, Evaluator ev) Sets an [Objective, evaluator] pair.
UtilitySpace	copy()
boolean	equals(java.lang.Object obj)
double	getEvaluation(int pIssueIndex, Bid bid) Returns the utility of one issue in the bid.
Evaluator	getEvaluator(int index) Returns the evaluator of an issue for the given index.
Evaluator	getEvaluator(Objective obj)
java.util.Set<java.util.Map.Entry<Objective,Evaluator>>	getEvaluators()
Objective	getIssue(int index) Deprecated. Use getObjective
int	getNrOfEvaluators()
double	getUtility(Bid bid) implements UtilitySpace
double	getWeight(int issueID)
java.lang.String	isComplete() Check if this utility space is complete and ready for negotiation.
boolean	lock(Objective obj) Place a lock on the weight of an objective or issue.
java.util.Set<java.util.Map.Entry<Objective,Evaluator>>	normalizeChildren(Objective obj) Normalizes the weights of objectives of the given objective so that they sum up to one.
double	setWeight(Objective objective, double weight) Method used to set the weight of the given objective.
java.lang.String	toString()
SimpleElement	toXML() Creates an xml representation (in the form of a SimpleElements) of the utilityspace.
boolean	unlock(Objective obj) Clear a lock on the weight of an objective or issue.

Methods inherited from class genius.core.utility.AbstractUtilitySpace

checkReadyForNegotiation, discount, getDiscountFactor, getDomain, getFileName, getMaxUtilityBid, getMinUtilityBid, getName, getReservationValue, getReservationValueUndiscounted, getReservationValueWithDiscount, getReservationValueWithDiscount, getUtilityWithDiscount, getUtilityWithDiscount, isDiscounted, setDiscount, setReservationValue, validateDiscount

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AdditiveUtilitySpace

public AdditiveUtilitySpace()

Creates an empty utility space.

AdditiveUtilitySpace

public AdditiveUtilitySpace(Domain domain)

Creates a new utilityspace of the given domain.

Parameters:

domain - for which the utilityspace should be specified.

AdditiveUtilitySpace

public AdditiveUtilitySpace(Domain domain,
                            java.util.Map<Objective,Evaluator> fEvaluators)

AdditiveUtilitySpace

public AdditiveUtilitySpace(Domain domain,
                            java.lang.String fileName)
                     throws java.io.IOException

Create new default util space for a given domain.

Parameters:

domain -

fileName - to read domain from. Set fileName to "" if no file available, in which case default evaluators are loaded..

Throws:

java.io.IOException - if error occurs, e.g. if domain does not match the util space, or file not found.

AdditiveUtilitySpace

public AdditiveUtilitySpace(AdditiveUtilitySpace us)

Copies the data from another UtilitySpace.

Parameters:

us - utility space to be cloned.

Method Detail

getUtility

public double getUtility(Bid bid)

implements UtilitySpace

Parameters:

bid - of which we are interested in its utility.

Returns:

Utility of the given bid. This utility is undiscounted: there is no time dependent devaluation of the utility. See also UtilitySpace.discount(double, double).

toXML

public SimpleElement toXML()
                    throws java.io.IOException

Description copied from interface: UtilitySpace

Creates an xml representation (in the form of a SimpleElements) of the utilityspace.

Returns:

A representation of this utilityspace or null when there was an error.

Throws:

java.io.IOException

isComplete

public java.lang.String isComplete()

Description copied from interface: UtilitySpace

Check if this utility space is complete and ready for negotiation.

Returns:

null if util space is complete, else returns String containing explanation why not.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

copy

public UtilitySpace copy()

Returns:

a deep copy of this utility space.

getNrOfEvaluators

public final int getNrOfEvaluators()

Returns:

number of issues. This can only be used for linear utility functions.

getEvaluator

public Evaluator getEvaluator(int index)

Returns the evaluator of an issue for the given index. This can only be used for linear utility functions.

Parameters:

index - The IDnumber of the Objective or Issue

Returns:

An Evaluator for the Objective or Issue.

getEvaluator

public Evaluator getEvaluator(Objective obj)

Parameters:

obj - the objective for which an evaluator is needed

Returns:

evaluator for given objective, or null if no such objective.

getEvaluation

public final double getEvaluation(int pIssueIndex,
                                  Bid bid)

Returns the utility of one issue in the bid. Note that this value is in the range [0,1] as it is not normalized by the issue weight. Only works with linear utility spaces.

Parameters:

pIssueIndex - of the issue.

bid -

Returns:

evaluation of the value of the issue of the given bid.

getWeight

public double getWeight(int issueID)

Parameters:

issueID - The Issue or Objective to get the weight from

Returns:

The weight, or 0 if the objective doesn't exist. Only works with linear utility spaces.

setWeight

public double setWeight(Objective objective,
                        double weight)

Method used to set the weight of the given objective. Only works with linear utility spaces.

Parameters:

objective - of which the weights must be set.

weight - to which the weight of the objective must be set.

Returns:

the new weight of the issue after normalization.

getIssue

@Deprecated
public final Objective getIssue(int index)

Deprecated. Use getObjective

Parameters:

index - The index of the issue to

Returns:

the indexed objective or issue

addEvaluator

public final Evaluator addEvaluator(Objective obj,
                                    Evaluator ev)

Sets an [Objective, evaluator] pair. Replaces old evaluator for objective. Only works with linear utility spaces.

Parameters:

obj - The Objective to attach an Evaluator to.

ev - The Evaluator to attach.

Returns:

The given evaluator.

getEvaluators

public final java.util.Set<java.util.Map.Entry<Objective,Evaluator>> getEvaluators()

Returns:

The set with all pairs of evaluators and objectives in this utility space. Only works with linear utility spaces.

lock

public final boolean lock(Objective obj)

Place a lock on the weight of an objective or issue. Only works with linear utility spaces.

Parameters:

obj - The objective or issue that is about to have it's weight locked.

Returns:

true if successful, false If the objective doesn't have an evaluator yet.

unlock

public final boolean unlock(Objective obj)

Clear a lock on the weight of an objective or issue. Only works with linear utility spaces.

Parameters:

obj - The objective or issue that is having it's lock cleared.

Returns:

true If the lock is cleared, false if the objective or issue doesn't have an evaluator yet.

normalizeChildren

public final java.util.Set<java.util.Map.Entry<Objective,Evaluator>> normalizeChildren(Objective obj)

Normalizes the weights of objectives of the given objective so that they sum up to one. Only works with linear utility spaces.

Parameters:

obj - of which the weights must be normalized.

Returns:

all evaluators using getEvaluators().