org.optaplanner.core.impl.score.buildin.hardsoft
Class HardSoftScoreDefinition

java.lang.Object
  org.optaplanner.core.impl.score.definition.AbstractScoreDefinition<HardSoftScore>
      org.optaplanner.core.impl.score.buildin.hardsoft.HardSoftScoreDefinition

All Implemented Interfaces:

Serializable, ScoreDefinition<HardSoftScore>

public class HardSoftScoreDefinition
extends AbstractScoreDefinition<HardSoftScore>

See Also:

Serialized Form

Constructor Summary

HardSoftScoreDefinition()

Method Summary

HardSoftScore	buildOptimisticBound(InitializingScoreTrend initializingScoreTrend, HardSoftScore score) Builds a Score which is equal or better than any other Score with more variables initialized (while the already variables don't change).
HardSoftScore	buildPessimisticBound(InitializingScoreTrend initializingScoreTrend, HardSoftScore score) Builds a Score which is equal or worse than any other Score with more variables initialized (while the already variables don't change).
HardSoftScoreHolder	buildScoreHolder(boolean constraintMatchEnabled) Used by DroolsScoreDirector.
double	calculateTimeGradient(HardSoftScore startScore, HardSoftScore endScore, HardSoftScore score) See explanation in Termination.calculateSolverTimeGradient(DefaultSolverScope).
double	getHardScoreTimeGradientWeight()
int	getLevelCount()
Class<HardSoftScore>	getScoreClass() Returns the Class of the actual Score implementation
HardSoftScore	parseScore(String scoreString) Parses the String and returns a Score.
void	setHardScoreTimeGradientWeight(double hardScoreTimeGradientWeight) It's recommended to use a number which can be exactly represented as a double, such as 0.5, 0.25, 0.75, 0.125, ... but not 0.1, 0.2, ...

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

HardSoftScoreDefinition

public HardSoftScoreDefinition()

Method Detail

getHardScoreTimeGradientWeight

public double getHardScoreTimeGradientWeight()

setHardScoreTimeGradientWeight

public void setHardScoreTimeGradientWeight(double hardScoreTimeGradientWeight)

It's recommended to use a number which can be exactly represented as a double, such as 0.5, 0.25, 0.75, 0.125, ... but not 0.1, 0.2, ...

Parameters:

hardScoreTimeGradientWeight - 0.0 <= hardScoreTimeGradientWeight <= 1.0

getLevelCount

public int getLevelCount()

Returns:

at least 1

getScoreClass

public Class<HardSoftScore> getScoreClass()

Description copied from interface: ScoreDefinition

Returns the Class of the actual Score implementation

Returns:

never null

parseScore

public HardSoftScore 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(HardSoftScore startScore,
                                    HardSoftScore endScore,
                                    HardSoftScore 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 HardSoftScoreHolder 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 HardSoftScore buildOptimisticBound(InitializingScoreTrend initializingScoreTrend,
                                          HardSoftScore 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 HardSoftScore buildPessimisticBound(InitializingScoreTrend initializingScoreTrend,
                                           HardSoftScore 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