rescuecore2.score

Class ConstantScoreFunction

java.lang.Object

rescuecore2.score.AbstractScoreFunction

rescuecore2.score.ConstantScoreFunction

All Implemented Interfaces:

ScoreFunction

public class ConstantScoreFunction
extends AbstractScoreFunction

A score function that returns a constant score.

Constructor Summary

Constructors

Constructor and Description
ConstantScoreFunction(java.lang.String name, double score) Create a ConstantScoreFunction.

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.
java.lang.String	toString()

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

ConstantScoreFunction

public ConstantScoreFunction(java.lang.String name,
                             double score)

Create a ConstantScoreFunction.

Parameters:

name - The name of this function.

score - The constant score.

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class AbstractScoreFunction

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 AbstractScoreFunction

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.