Package org.optaplanner.core.impl.score.buildin

Class SimpleScoreDefinition

java.lang.Object

org.optaplanner.core.impl.score.definition.AbstractScoreDefinition<SimpleScore>

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

All Implemented Interfaces:

ScoreDefinition<SimpleScore>

public class SimpleScoreDefinition
extends AbstractScoreDefinition<SimpleScore>

Constructor Summary

Constructors

Constructor	Description
SimpleScoreDefinition()

Method Summary

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

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

divide, divide, divide, divide, formatScore, getInitLabel, getLevelLabels, 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 org.optaplanner.core.impl.score.definition.ScoreDefinition

isNegativeOrZero, isPositiveOrZero

Constructor Details

SimpleScoreDefinition

public SimpleScoreDefinition()

Method Details

getLevelsSize

public int getLevelsSize()

Description copied from interface: ScoreDefinition

Returns the length of Score.toLevelNumbers() for every Score of this definition. For example: returns 2 on HardSoftScoreDefinition.

Specified by:

getLevelsSize in interface ScoreDefinition<SimpleScore>

Overrides:

getLevelsSize in class AbstractScoreDefinition<SimpleScore>

Returns:

at least 1

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<SimpleScore> 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 SimpleScore getZeroScore()

Description copied from interface: ScoreDefinition

The score that represents zero.

Returns:

never null

getOneSoftestScore

public SimpleScore getOneSoftestScore()

Description copied from interface: ScoreDefinition

The score that represents the softest possible one.

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)

fromLevelNumbers

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

Description copied from interface: ScoreDefinition

The opposite of Score.toLevelNumbers().

Parameters:

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

levelNumbers - never null

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

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

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

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

Returns:

never null

divideBySanitizedDivisor

public SimpleScore divideBySanitizedDivisor(SimpleScore dividend,
 SimpleScore 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