rescuecore2.score

Class CumulativeScoreFunction

java.lang.Object

rescuecore2.score.AbstractScoreFunction

rescuecore2.score.CompositeScoreFunction

rescuecore2.score.CumulativeScoreFunction

All Implemented Interfaces:

ScoreFunction

public class CumulativeScoreFunction
extends CompositeScoreFunction

A score function that accumulates scores from a set of child score functions.

Field Summary

Fields inherited from class rescuecore2.score.CompositeScoreFunction

children

Constructor Summary

Constructors

Constructor and Description
CumulativeScoreFunction(java.lang.String name) Create a CumulativeScoreFunction with no children.
CumulativeScoreFunction(java.lang.String name, java.util.Collection<ScoreFunction> children) Create a CumulativeScoreFunction with a collection of children.
CumulativeScoreFunction(java.lang.String name, ScoreFunction... children) Create a CumulativeScoreFunction with a collection of children.

Method Summary

Modifier and Type	Method and Description
void	initialise(WorldModel<? extends Entity> world, Config config) Initialise this score function.
double	score(WorldModel<? extends Entity> world, Timestep timestep) Calculate the score for a timestep.

Methods inherited from class rescuecore2.score.CompositeScoreFunction

addChildFunction, addChildFunctions, addChildFunctions, getChildFunctions, removeChildFunction, removeChildFunctions, removeChildFunctions

Methods inherited from class rescuecore2.score.AbstractScoreFunction

getName, setName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CumulativeScoreFunction

public CumulativeScoreFunction(java.lang.String name)

Create a CumulativeScoreFunction with no children.

Parameters:

name - The name of this function.

CumulativeScoreFunction

public CumulativeScoreFunction(java.lang.String name,
                               java.util.Collection<ScoreFunction> children)

Create a CumulativeScoreFunction with a collection of children.

Parameters:

name - The name of this function.

children - The child score functions.

CumulativeScoreFunction

public CumulativeScoreFunction(java.lang.String name,
                               ScoreFunction... children)

Create a CumulativeScoreFunction with a collection of children.

Parameters:

name - The name of this function.

children - The child score functions.

Method Detail

initialise

public void initialise(WorldModel<? extends Entity> world,
                       Config config)

Description copied from interface: ScoreFunction

Initialise this score function.

Specified by:

initialise in interface ScoreFunction

Overrides:

initialise in class CompositeScoreFunction

Parameters:

world - The state of the world at the start of the simulation.

config - The system configuration.

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.