org.jamesframework.ext.problems.objectives.evaluations

Class WeightedIndexEvaluation

java.lang.Object

org.jamesframework.ext.problems.objectives.evaluations.WeightedIndexEvaluation

All Implemented Interfaces:

Evaluation

public class WeightedIndexEvaluation
extends Object
implements Evaluation

Evaluation produced by a weighted index. Contains evaluations produced by the underlying objectives and the respective weights. The double value is computed as a weighted sum of the double values of all contained objectives.

Author:

Herman De Beukelaer

Constructor Summary

Constructors

Constructor and Description
WeightedIndexEvaluation() Create an empty evaluation.

Method Summary

Modifier and Type	Method and Description
void	addEvaluation(Objective obj, Evaluation eval, double weight) Add an evaluation produced by an objective, specifying its weight.
Evaluation	getEvaluation(Objective obj) Get a previously added evaluation produced by a specific objective.
double	getValue() The value consist of the weighted sum of the values of all added evaluations.
String	toString() Format value as string.

Methods inherited from class java.lang.Object

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

Constructor Detail

WeightedIndexEvaluation

public WeightedIndexEvaluation()

Create an empty evaluation.

Method Detail

addEvaluation

public void addEvaluation(Objective obj,
                          Evaluation eval,
                          double weight)

Add an evaluation produced by an objective, specifying its weight.

Parameters:

obj - objective

eval - produced evaluation

weight - assigned weight

getEvaluation

public Evaluation getEvaluation(Objective obj)

Get a previously added evaluation produced by a specific objective. If no evaluation has been added with this objective as its key, null is returned.

Parameters:

obj - objective

Returns:

evaluation produced by this objective, may be null

getValue

public double getValue()

The value consist of the weighted sum of the values of all added evaluations. The value is only guaranteed to be correct if the evaluation objects have not been modified after they were added to this weighted index evaluation.

Specified by:

getValue in interface Evaluation

Returns:

weighted sum of values

toString

public String toString()

Format value as string.

Overrides:

toString in class Object

Returns:

string version of value