org.optaplanner.core.impl.score.buildin.bendable
Class BendableScoreDefinition

java.lang.Object
  org.optaplanner.core.impl.score.definition.AbstractScoreDefinition<BendableScore>
      org.optaplanner.core.impl.score.buildin.bendable.BendableScoreDefinition

All Implemented Interfaces:

Serializable, ScoreDefinition<BendableScore>

public class BendableScoreDefinition
extends AbstractScoreDefinition<BendableScore>

See Also:

Serialized Form

Constructor Summary

BendableScoreDefinition(int hardLevelCount, int softLevelCount)

Method Summary

BendableScore	buildOptimisticBound(InitializingScoreTrend initializingScoreTrend, BendableScore score) Builds a Score which is equal or better than any other Score with more variables initialized (while the already variables don't change).
BendableScore	buildPessimisticBound(InitializingScoreTrend initializingScoreTrend, BendableScore score) Builds a Score which is equal or worse than any other Score with more variables initialized (while the already variables don't change).
BendableScoreHolder	buildScoreHolder(boolean constraintMatchEnabled) Used by DroolsScoreDirector.
double	calculateTimeGradient(BendableScore startScore, BendableScore endScore, BendableScore score) See explanation in Termination.calculateSolverTimeGradient(DefaultSolverScope).
BendableScore	createScore(int... scores)
int	getHardLevelCount()
int	getLevelCount()
double	getRecursiveTimeGradientWeight()
Class<BendableScore>	getScoreClass() Returns the Class of the actual Score implementation
int	getSoftLevelCount()
BendableScore	parseScore(String scoreString) Parses the String and returns a Score.
void	setRecursiveTimeGradientWeight(double recursiveTimeGradientWeight) 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

BendableScoreDefinition

public BendableScoreDefinition(int hardLevelCount,
                               int softLevelCount)

Method Detail

getHardLevelCount

public int getHardLevelCount()

getSoftLevelCount

public int getSoftLevelCount()

getRecursiveTimeGradientWeight

public double getRecursiveTimeGradientWeight()

setRecursiveTimeGradientWeight

public void setRecursiveTimeGradientWeight(double recursiveTimeGradientWeight)

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:

recursiveTimeGradientWeight - 0.0 <= recursiveTimeGradientWeight <= 1.0

getLevelCount

public int getLevelCount()

Returns:

at least 1

getScoreClass

public Class<BendableScore> getScoreClass()

Description copied from interface: ScoreDefinition

Returns the Class of the actual Score implementation

Returns:

never null

parseScore

public BendableScore 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)

createScore

public BendableScore createScore(int... scores)

calculateTimeGradient

public double calculateTimeGradient(BendableScore startScore,
                                    BendableScore endScore,
                                    BendableScore 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 BendableScoreHolder 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 BendableScore buildOptimisticBound(InitializingScoreTrend initializingScoreTrend,
                                          BendableScore 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 BendableScore buildPessimisticBound(InitializingScoreTrend initializingScoreTrend,
                                           BendableScore 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