org.optaplanner.core.impl.score.buildin.hardsoftdouble

Class HardSoftDoubleScoreDefinition

java.lang.Object

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

org.optaplanner.core.impl.score.definition.AbstractFeasibilityScoreDefinition<HardSoftDoubleScore>

org.optaplanner.core.impl.score.buildin.hardsoftdouble.HardSoftDoubleScoreDefinition

All Implemented Interfaces:

Serializable, FeasibilityScoreDefinition<HardSoftDoubleScore>, ScoreDefinition<HardSoftDoubleScore>

public class HardSoftDoubleScoreDefinition
extends AbstractFeasibilityScoreDefinition<HardSoftDoubleScore>

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HardSoftDoubleScoreDefinition()

Method Summary

Modifier and Type	Method and Description
HardSoftDoubleScore	buildOptimisticBound(InitializingScoreTrend initializingScoreTrend, HardSoftDoubleScore score) Builds a Score which is equal or better than any other Score with more variables initialized (while the already variables don't change).
HardSoftDoubleScore	buildPessimisticBound(InitializingScoreTrend initializingScoreTrend, HardSoftDoubleScore score) Builds a Score which is equal or worse than any other Score with more variables initialized (while the already variables don't change).
HardSoftDoubleScoreHolder	buildScoreHolder(boolean constraintMatchEnabled) Used by DroolsScoreDirector.
HardSoftDoubleScore	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<HardSoftDoubleScore>	getScoreClass() Returns the Class of the actual Score implementation.
HardSoftDoubleScore	getZeroScore() The score that represents zero.
HardSoftDoubleScore	parseScore(String scoreString) Parses the String and returns a Score.

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

formatScore, getInitLabel, getLevelLabels, 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

formatScore, getInitLabel, getLevelLabels

Constructor Detail

HardSoftDoubleScoreDefinition

public HardSoftDoubleScoreDefinition()

Method Detail

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<HardSoftDoubleScore>

Overrides:

getLevelsSize in class AbstractScoreDefinition<HardSoftDoubleScore>

Returns:

at least 1

getFeasibleLevelsSize

public int getFeasibleLevelsSize()

Description copied from interface: FeasibilityScoreDefinition

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

Returns:

at least 0, at most ScoreDefinition.getLevelsSize()

getScoreClass

public Class<HardSoftDoubleScore> 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 HardSoftDoubleScore getZeroScore()

Description copied from interface: ScoreDefinition

The score that represents zero.

Returns:

never null

parseScore

public HardSoftDoubleScore 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), ScoreUtils.parseScore(Class, String)

fromLevelNumbers

public HardSoftDoubleScore 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.getInitScore()

levelNumbers - never null

Returns:

never null

buildScoreHolder

public HardSoftDoubleScoreHolder 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 HardSoftDoubleScore buildOptimisticBound(InitializingScoreTrend initializingScoreTrend,
                                                HardSoftDoubleScore 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.getInitScore() 0.

Returns:

never null

buildPessimisticBound

public HardSoftDoubleScore buildPessimisticBound(InitializingScoreTrend initializingScoreTrend,
                                                 HardSoftDoubleScore 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.getInitScore() 0

Returns:

never null