rescuecore2.score

Class MultiplicativeScoreFunction

java.lang.Object

rescuecore2.score.AbstractScoreFunction

rescuecore2.score.CompositeScoreFunction

rescuecore2.score.MultiplicativeScoreFunction

All Implemented Interfaces:

ScoreFunction

Direct Known Subclasses:

LegacyScoreFunction

public class MultiplicativeScoreFunction
extends CompositeScoreFunction

A score function that returns a set child score functions multiplied together.

Field Summary

Fields inherited from class rescuecore2.score.CompositeScoreFunction

children

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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, removeChildFunction, 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

MultiplicativeScoreFunction

public MultiplicativeScoreFunction(java.lang.String name)

Create a MultiplicativeScoreFunction with no children.

Parameters:

name - The name of this function.

MultiplicativeScoreFunction

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

Create a MultiplicativeScoreFunction with a collection of children.

Parameters:

name - The name of this function.

children - The child score functions.

MultiplicativeScoreFunction

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

Create a MultiplicativeScoreFunction with a collection of children.

Parameters:

name - The name of this function.

children - The child score functions.

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class AbstractScoreFunction

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.