Package ai.timefold.solver.core.impl.score.buildin

Class HardSoftScoreDefinition

java.lang.Object

ai.timefold.solver.core.impl.score.definition.AbstractScoreDefinition<HardSoftScore>

ai.timefold.solver.core.impl.score.buildin.HardSoftScoreDefinition

All Implemented Interfaces:

ScoreDefinition<HardSoftScore>

public class HardSoftScoreDefinition
extends AbstractScoreDefinition<HardSoftScore>

Constructor Summary

Constructors

Constructor	Description
HardSoftScoreDefinition()

Method Summary

Modifier and Type	Method	Description
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).
HardSoftScore	divideBySanitizedDivisor(HardSoftScore dividend, HardSoftScore divisor)	Return Score whose every level is the result of dividing the matching levels in this and the divisor.
HardSoftScore	fromLevelNumbers(int initScore, Number[] levelNumbers)	The opposite of Score.toLevelNumbers().
int	getFeasibleLevelsSize()	Returns the number of levels of Score.toLevelNumbers().
Class<?>	getNumericType()	Return the type of number that the score implementation operates on.
HardSoftScore	getOneSoftestScore()	The score that represents the softest possible one.
Class<HardSoftScore>	getScoreClass()	Returns the Class of the actual Score implementation.
HardSoftScore	getZeroScore()	The score that represents zero.
HardSoftScore	parseScore(String scoreString)	Parses the String and returns a Score.

Methods inherited from class ai.timefold.solver.core.impl.score.definition.AbstractScoreDefinition

divide, divide, divide, divide, formatScore, getInitLabel, getLevelLabels, getLevelsSize, isCompatibleArithmeticArgument, sanitize, sanitize, sanitize, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.timefold.solver.core.impl.score.definition.ScoreDefinition

isNegativeOrZero, isPositiveOrZero

Constructor Detail

HardSoftScoreDefinition

public HardSoftScoreDefinition()

Method Detail

getFeasibleLevelsSize

public int getFeasibleLevelsSize()

Description copied from interface: ScoreDefinition

Returns the number of levels of Score.toLevelNumbers(). that are used to determine Score.isFeasible().

Returns:

at least 0, at most ScoreDefinition.getLevelsSize()

getScoreClass

public Class<HardSoftScore> getScoreClass()

Description copied from interface: ScoreDefinition

Returns the Class of the actual Score implementation. For example: returns HardSoftScore.class on HardSoftScoreDefinition.

Returns:

never null

getZeroScore

public HardSoftScore getZeroScore()

Description copied from interface: ScoreDefinition

The score that represents zero.

Returns:

never null

getOneSoftestScore

public HardSoftScore getOneSoftestScore()

Description copied from interface: ScoreDefinition

The score that represents the softest possible one.

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)

fromLevelNumbers

public HardSoftScore fromLevelNumbers(int initScore,
                                      Number[] levelNumbers)

Description copied from interface: ScoreDefinition

The opposite of Score.toLevelNumbers().

Parameters:

initScore - <= 0, managed by Timefold, needed as a parameter in the Score's creation method, see Score.initScore()

levelNumbers - never null

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.getLevelsSize() equal to ScoreDefinition.getLevelsSize().

score - never null, with Score.initScore() 0.

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.getLevelsSize() equal to ScoreDefinition.getLevelsSize().

score - never null, with Score.initScore() 0

Returns:

never null

divideBySanitizedDivisor

public HardSoftScore divideBySanitizedDivisor(HardSoftScore dividend,
                                              HardSoftScore divisor)

Description copied from interface: ScoreDefinition

Return Score whose every level is the result of dividing the matching levels in this and the divisor. When rounding is needed, it is floored (as defined by Math.floor(double)).

If any of the levels in the divisor are equal to zero, the method behaves as if they were equal to one instead.

divisor - value by which this Score is to be divided

Returns:

this / divisor

getNumericType

public Class<?> getNumericType()

Description copied from interface: ScoreDefinition

Return the type of number that the score implementation operates on. Examples:

• int.class for SimpleScore
• BigDecimal.class for SimpleBigDecimalScore

Returns:

never null