org.optaplanner.core.impl.score.buildin.simple
Class SimpleScoreDefinition

java.lang.Object
  org.optaplanner.core.impl.score.definition.AbstractScoreDefinition<SimpleScore>
      org.optaplanner.core.impl.score.buildin.simple.SimpleScoreDefinition

All Implemented Interfaces:

Serializable, ScoreDefinition<SimpleScore>

public class SimpleScoreDefinition
extends AbstractScoreDefinition<SimpleScore>

See Also:

Serialized Form

Constructor Summary

SimpleScoreDefinition()

Method Summary

SimpleScore	buildOptimisticBound(InitializingScoreTrend initializingScoreTrend, SimpleScore score) Builds a Score which is equal or better than any other Score with more variables initialized (while the already variables don't change).
SimpleScore	buildPessimisticBound(InitializingScoreTrend initializingScoreTrend, SimpleScore score) Builds a Score which is equal or worse than any other Score with more variables initialized (while the already variables don't change).
SimpleScoreHolder	buildScoreHolder(boolean constraintMatchEnabled) Used by DroolsScoreDirector.
double	calculateTimeGradient(SimpleScore startScore, SimpleScore endScore, SimpleScore score) See explanation in Termination.calculateSolverTimeGradient(DefaultSolverScope).
int	getLevelCount()
Class<SimpleScore>	getScoreClass() Returns the Class of the actual Score implementation
SimpleScore	parseScore(String scoreString) Parses the String and returns a Score.

Methods inherited from class org.optaplanner.core.impl.score.definition.AbstractScoreDefinition

formatScore

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleScoreDefinition

public SimpleScoreDefinition()

Method Detail

getLevelCount

public int getLevelCount()

Returns:

at least 1

getScoreClass

public Class<SimpleScore> getScoreClass()

Description copied from interface: ScoreDefinition

Returns the Class of the actual Score implementation

Returns:

never null

parseScore

public SimpleScore parseScore(String scoreString)

Description copied from interface: ScoreDefinition

Parses the String and returns a Score.

Parameters:

scoreString - never null

Returns:

never null

See Also:

ScoreDefinition.formatScore(Score)

calculateTimeGradient

public double calculateTimeGradient(SimpleScore startScore,
                                    SimpleScore endScore,
                                    SimpleScore score)

Description copied from interface: ScoreDefinition

See explanation in Termination.calculateSolverTimeGradient(DefaultSolverScope).

Parameters:

startScore - never null

endScore - never null

score - never null

Returns:

between 0.0 and 1.0

buildScoreHolder

public SimpleScoreHolder buildScoreHolder(boolean constraintMatchEnabled)

Description copied from interface: ScoreDefinition

Used by DroolsScoreDirector.

Parameters:

constraintMatchEnabled - true if ScoreHolder.isConstraintMatchEnabled() should be true

Returns:

never null

buildOptimisticBound

public SimpleScore buildOptimisticBound(InitializingScoreTrend initializingScoreTrend,
                                        SimpleScore score)

Description copied from interface: ScoreDefinition

Builds a Score which is equal or better than any other Score with more variables initialized (while the already variables don't change).

Parameters:

initializingScoreTrend - never null, with InitializingScoreTrend.getLevelCount() equal to ScoreDefinition.getLevelCount().

score - never null

Returns:

never null

buildPessimisticBound

public SimpleScore buildPessimisticBound(InitializingScoreTrend initializingScoreTrend,
                                         SimpleScore score)

Description copied from interface: ScoreDefinition

Builds a Score which is equal or worse than any other Score with more variables initialized (while the already variables don't change).

Parameters:

initializingScoreTrend - never null, with InitializingScoreTrend.getLevelCount() equal to ScoreDefinition.getLevelCount().

score - never null

Returns:

never null