rescuecore2.score

Class WeightedScoreFunction

java.lang.Object

rescuecore2.score.AbstractScoreFunction

rescuecore2.score.CompositeScoreFunction

rescuecore2.score.WeightedScoreFunction

All Implemented Interfaces:

ScoreFunction

public class WeightedScoreFunction
extends CompositeScoreFunction

A score function that returns a weighted sum of child score functions.

Field Summary

Fields inherited from class rescuecore2.score.CompositeScoreFunction

children

Constructor Summary

Constructors

Constructor and Description
WeightedScoreFunction(java.lang.String name) Create a WeightedScoreFunction with no children.

Method Summary

Modifier and Type	Method and Description
void	addChildFunction(ScoreFunction child, double weight) Add a child score function with a weight.
void	removeChildFunction(ScoreFunction child) Remove a child score function.
double	score(WorldModel<? extends Entity> world, Timestep timestep) Calculate the score for a timestep.
java.lang.String	toString()

Methods inherited from class rescuecore2.score.CompositeScoreFunction

addChildFunction, addChildFunctions, addChildFunctions, getChildFunctions, initialise, removeChildFunctions, removeChildFunctions

Methods inherited from class rescuecore2.score.AbstractScoreFunction

getName, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

WeightedScoreFunction

public WeightedScoreFunction(java.lang.String name)

Create a WeightedScoreFunction with no children.

Parameters:

name - The name of this function.

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class AbstractScoreFunction

addChildFunction

public void addChildFunction(ScoreFunction child,
                             double weight)

Add a child score function with a weight.

Parameters:

child - The child score function to add.

weight - The weight of this child function.

removeChildFunction

public void removeChildFunction(ScoreFunction child)

Description copied from class: CompositeScoreFunction

Remove a child score function.

Overrides:

removeChildFunction in class CompositeScoreFunction

Parameters:

child - The child function to remove.

score

public double score(WorldModel<? extends Entity> world,
                    Timestep timestep)

Description copied from interface: ScoreFunction

Calculate the score for a timestep.

Parameters:

world - The state of the world at the end of the timestep.

timestep - The record of perception, commands and changes for the timestep.

Returns:

The score for this timestep.