org.optaplanner.core.impl.score.buildin.simpledouble
Class SimpleDoubleScoreDefinition

java.lang.Object
  org.optaplanner.core.impl.score.definition.AbstractScoreDefinition<SimpleDoubleScore>
      org.optaplanner.core.impl.score.buildin.simpledouble.SimpleDoubleScoreDefinition

All Implemented Interfaces:

Serializable, ScoreDefinition<SimpleDoubleScore>

public class SimpleDoubleScoreDefinition
extends AbstractScoreDefinition<SimpleDoubleScore>

See Also:

Serialized Form

Constructor Summary

SimpleDoubleScoreDefinition()

Method Summary

ScoreHolder	buildScoreHolder(boolean constraintMatchEnabled)
double	calculateTimeGradient(SimpleDoubleScore startScore, SimpleDoubleScore endScore, SimpleDoubleScore score) See explanation in Termination.calculateSolverTimeGradient(DefaultSolverScope).
SimpleDoubleScore	getPerfectMaximumScore() The perfect maximum Score is the Score of which there is no better in any problem instance.
SimpleDoubleScore	getPerfectMinimumScore() The perfect minimum Score is the Score of which there is no worse in any problem instance.
Class<SimpleDoubleScore>	getScoreClass() Returns the Class of the actual Score implementation
Score	parseScore(String scoreString) Parses the String and returns a Score.
void	setPerfectMaximumScore(SimpleDoubleScore perfectMaximumScore)
void	setPerfectMinimumScore(SimpleDoubleScore perfectMinimumScore)

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

SimpleDoubleScoreDefinition

public SimpleDoubleScoreDefinition()

Method Detail

getPerfectMaximumScore

public SimpleDoubleScore getPerfectMaximumScore()

Description copied from interface: ScoreDefinition

The perfect maximum Score is the Score of which there is no better in any problem instance. This doesn't mean that the current problem instance, or any problem instance for that matter, could ever attain that Score.

For example, most cases have a perfect maximum Score of zero, as most use cases only have negative constraints.

Specified by:

getPerfectMaximumScore in interface ScoreDefinition<SimpleDoubleScore>

Overrides:

getPerfectMaximumScore in class AbstractScoreDefinition<SimpleDoubleScore>

Returns:

null if not supported

setPerfectMaximumScore

public void setPerfectMaximumScore(SimpleDoubleScore perfectMaximumScore)

getPerfectMinimumScore

public SimpleDoubleScore getPerfectMinimumScore()

Description copied from interface: ScoreDefinition

The perfect minimum Score is the Score of which there is no worse in any problem instance. This doesn't mean that the current problem instance, or any problem instance for that matter, could ever attain such a bad Score.

For example, most cases have a perfect minimum Score of negative infinity.

Specified by:

getPerfectMinimumScore in interface ScoreDefinition<SimpleDoubleScore>

Overrides:

getPerfectMinimumScore in class AbstractScoreDefinition<SimpleDoubleScore>

Returns:

null if not supported

setPerfectMinimumScore

public void setPerfectMinimumScore(SimpleDoubleScore perfectMinimumScore)

getScoreClass

public Class<SimpleDoubleScore> getScoreClass()

Description copied from interface: ScoreDefinition

Returns the Class of the actual Score implementation

Returns:

never null

parseScore

public Score 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(SimpleDoubleScore startScore,
                                    SimpleDoubleScore endScore,
                                    SimpleDoubleScore 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 ScoreHolder buildScoreHolder(boolean constraintMatchEnabled)

Parameters:

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

Returns:

never null