org.optaplanner.core.api.score.buildin.bendable

Class BendableScore

java.lang.Object

org.optaplanner.core.api.score.AbstractScore<S>

org.optaplanner.core.api.score.AbstractBendableScore<BendableScore>

org.optaplanner.core.api.score.buildin.bendable.BendableScore

All Implemented Interfaces:

Serializable, Comparable<BendableScore>, FeasibilityScore<BendableScore>, Score<BendableScore>

public final class BendableScore
extends AbstractBendableScore<BendableScore>
implements FeasibilityScore<BendableScore>

This Score is based on n levels of int constraints. The number of levels is bendable at configuration time.

This class is immutable.

The getHardLevelsSize() and getSoftLevelsSize() must be the same as in the BendableScoreDefinition used.

See Also:

Score, Serialized Form

Field Summary

Fields inherited from class org.optaplanner.core.api.score.AbstractBendableScore

HARD_LABEL, LEVEL_SUFFIXES, SOFT_LABEL

Fields inherited from class org.optaplanner.core.api.score.AbstractScore

INIT_LABEL, initScore

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BendableScore(int initScore, int[] hardScores, int[] softScores)

Method Summary

Modifier and Type	Method and Description
BendableScore	add(BendableScore augment) Returns a Score whose value is (this + augment).
int	compareTo(BendableScore other)
BendableScore	divide(double divisor) Returns a Score whose value is (this / divisor).
boolean	equals(Object o)
int	getHardLevelsSize() The sum of this and AbstractBendableScore.getSoftLevelsSize() equals AbstractBendableScore.getLevelsSize().
int	getHardOrSoftScore(int level)
int	getHardScore(int hardLevel)
int[]	getHardScores()
int	getLevelsSize()
int	getSoftLevelsSize() The sum of AbstractBendableScore.getHardLevelsSize() and this equals AbstractBendableScore.getLevelsSize().
int	getSoftScore(int softLevel)
int[]	getSoftScores()
int	hashCode()
boolean	isCompatibleArithmeticArgument(Score otherScore)
boolean	isFeasible() A PlanningSolution is feasible if it has no broken hard constraints and Score.isSolutionInitialized() is true.
BendableScore	multiply(double multiplicand) Returns a Score whose value is (this * multiplicand).
BendableScore	negate() Returns a Score whose value is (- this).
static BendableScore	parseScore(String scoreString)
BendableScore	power(double exponent) Returns a Score whose value is (this ^ exponent).
BendableScore	subtract(BendableScore subtrahend) Returns a Score whose value is (this - subtrahend).
BendableScore	toInitializedScore() For example -7init/0hard/-8soft returns 0hard/-8soft.
Number[]	toLevelNumbers() Returns an array of numbers representing the Score.
String	toShortString() Like Object.toString(), but trims score levels which have a zero weight.
String	toString()
void	validateCompatible(BendableScore other)
static BendableScore	valueOf(int[] hardScores, int[] softScores) Creates a new BendableScore.
static BendableScore	valueOfUninitialized(int initScore, int[] hardScores, int[] softScores) Creates a new BendableScore.
BendableScore	withInitScore(int newInitScore) For example 0hard/-8soft with -7 returns -7init/0hard/-8soft.
static BendableScore	zero(int hardLevelsSize, int softLevelsSize)

Methods inherited from class org.optaplanner.core.api.score.AbstractBendableScore

buildBendableShortString, parseBendableScoreTokens

Methods inherited from class org.optaplanner.core.api.score.AbstractScore

assertNoInitScore, buildScorePattern, buildShortString, getInitPrefix, getInitScore, isSolutionInitialized, parseInitScore, parseLevelAsBigDecimal, parseLevelAsDouble, parseLevelAsInt, parseLevelAsLong, parseScoreTokens

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.optaplanner.core.api.score.Score

getInitScore, isSolutionInitialized

Constructor Detail

BendableScore

protected BendableScore(int initScore,
                        int[] hardScores,
                        int[] softScores)

Parameters:

initScore - see Score.getInitScore()

hardScores - never null

softScores - never null

Method Detail

parseScore

public static BendableScore parseScore(String scoreString)

Parameters:

scoreString - never null

Returns:

never null

valueOfUninitialized

public static BendableScore valueOfUninitialized(int initScore,
                                                 int[] hardScores,
                                                 int[] softScores)

Creates a new BendableScore.

Parameters:

initScore - see Score.getInitScore()

hardScores - never null, never change that array afterwards: it must be immutable

softScores - never null, never change that array afterwards: it must be immutable

Returns:

never null

valueOf

public static BendableScore valueOf(int[] hardScores,
                                    int[] softScores)

Creates a new BendableScore.

Parameters:

hardScores - never null, never change that array afterwards: it must be immutable

softScores - never null, never change that array afterwards: it must be immutable

Returns:

never null

zero

public static BendableScore zero(int hardLevelsSize,
                                 int softLevelsSize)

getHardScores

public int[] getHardScores()

Returns:

not null, array copy because this class is immutable

getSoftScores

public int[] getSoftScores()

Returns:

not null, array copy because this class is immutable

getHardLevelsSize

public int getHardLevelsSize()

Description copied from class: AbstractBendableScore

The sum of this and AbstractBendableScore.getSoftLevelsSize() equals AbstractBendableScore.getLevelsSize().

Specified by:

getHardLevelsSize in class AbstractBendableScore<BendableScore>

Returns:

>= 0 and < AbstractBendableScore.getLevelsSize()

getHardScore

public int getHardScore(int hardLevel)

Parameters:

hardLevel - 0 <= hardLevel < getHardLevelsSize(). The scoreLevel is hardLevel for hard levels and softLevel + hardLevelSize for soft levels.

Returns:

higher is better

getSoftLevelsSize

public int getSoftLevelsSize()

Description copied from class: AbstractBendableScore

The sum of AbstractBendableScore.getHardLevelsSize() and this equals AbstractBendableScore.getLevelsSize().

Specified by:

getSoftLevelsSize in class AbstractBendableScore<BendableScore>

Returns:

>= 0 and < AbstractBendableScore.getLevelsSize()

getSoftScore

public int getSoftScore(int softLevel)

Parameters:

softLevel - 0 <= softLevel < getSoftLevelsSize(). The scoreLevel is hardLevel for hard levels and softLevel + hardLevelSize for soft levels.

Returns:

higher is better

toInitializedScore

public BendableScore toInitializedScore()

Description copied from interface: Score

For example -7init/0hard/-8soft returns 0hard/-8soft.

Specified by:

toInitializedScore in interface Score<BendableScore>

Returns:

equal score except that Score.getInitScore() is 0.

withInitScore

public BendableScore withInitScore(int newInitScore)

Description copied from interface: Score

For example 0hard/-8soft with -7 returns -7init/0hard/-8soft.

Specified by:

withInitScore in interface Score<BendableScore>

Parameters:

newInitScore - always negative (except in statistical calculations), 0 if all planning variables are initialized

Returns:

equals score except that Score.getInitScore() is set to newInitScore

getLevelsSize

public int getLevelsSize()

Specified by:

getLevelsSize in class AbstractBendableScore<BendableScore>

Returns:

AbstractBendableScore.getHardLevelsSize() + AbstractBendableScore.getSoftLevelsSize()

getHardOrSoftScore

public int getHardOrSoftScore(int level)

Parameters:

level - 0 <= level < getLevelsSize()

Returns:

higher is better

isFeasible

public boolean isFeasible()

Description copied from interface: FeasibilityScore

A PlanningSolution is feasible if it has no broken hard constraints and Score.isSolutionInitialized() is true.

Specified by:

isFeasible in interface FeasibilityScore<BendableScore>

Returns:

true if the hard score is 0 or higher and the Score.getInitScore() is 0.

add

public BendableScore add(BendableScore augment)

Description copied from interface: Score

Returns a Score whose value is (this + augment).

Specified by:

add in interface Score<BendableScore>

Parameters:

augment - value to be added to this Score

Returns:

this + augment

subtract

public BendableScore subtract(BendableScore subtrahend)

Description copied from interface: Score

Returns a Score whose value is (this - subtrahend).

Specified by:

subtract in interface Score<BendableScore>

Parameters:

subtrahend - value to be subtracted from this Score

Returns:

this - subtrahend, rounded as necessary

multiply

public BendableScore multiply(double multiplicand)

Description copied from interface: Score

Returns a Score whose value is (this * multiplicand). When rounding is needed, it should be floored (as defined by Math.floor(double)).

If the implementation has a scale/precision, then the unspecified scale/precision of the double multiplicand should have no impact on the returned scale/precision.

Specified by:

multiply in interface Score<BendableScore>

Parameters:

multiplicand - value to be multiplied by this Score.

Returns:

this * multiplicand

divide

public BendableScore divide(double divisor)

Description copied from interface: Score

Returns a Score whose value is (this / divisor). When rounding is needed, it should be floored (as defined by Math.floor(double)).

If the implementation has a scale/precision, then the unspecified scale/precision of the double divisor should have no impact on the returned scale/precision.

Specified by:

divide in interface Score<BendableScore>

Parameters:

divisor - value by which this Score is to be divided

Returns:

this / divisor

power

public BendableScore power(double exponent)

Description copied from interface: Score

Returns a Score whose value is (this ^ exponent). When rounding is needed, it should be floored (as defined by Math.floor(double)).

If the implementation has a scale/precision, then the unspecified scale/precision of the double exponent should have no impact on the returned scale/precision.

Specified by:

power in interface Score<BendableScore>

Parameters:

exponent - value by which this Score is to be powered

Returns:

this ^ exponent

negate

public BendableScore negate()

Description copied from interface: Score

Returns a Score whose value is (- this).

Specified by:

negate in interface Score<BendableScore>

Returns:

- this

toLevelNumbers

public Number[] toLevelNumbers()

Description copied from interface: Score

Returns an array of numbers representing the Score. Each number represents 1 score level. A greater score level uses a lower array index than a lesser score level.

When rounding is needed, each rounding should be floored (as defined by Math.floor(double)). The length of the returned array must be stable for a specific Score implementation.

For example: -0hard/-7soft returns new int{-0, -7}

The level numbers do not contain the Score.getInitScore(). For example: -3init/-0hard/-7soft also returns new int{-0, -7}

Specified by:

toLevelNumbers in interface Score<BendableScore>

Returns:

never null

See Also:

ScoreDefinition.fromLevelNumbers(int, Number[])

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(BendableScore other)

Specified by:

compareTo in interface Comparable<BendableScore>

toShortString

public String toShortString()

Description copied from interface: Score

Like Object.toString(), but trims score levels which have a zero weight. For example 0hard/-258soft returns -258soft.

Do not use this format to persist information as text, use Object.toString() instead, so it can be parsed reliably.

Specified by:

toShortString in interface Score<BendableScore>

Returns:

never null

toString

public String toString()

Overrides:

toString in class Object

validateCompatible

public void validateCompatible(BendableScore other)

isCompatibleArithmeticArgument

public boolean isCompatibleArithmeticArgument(Score otherScore)

Specified by:

isCompatibleArithmeticArgument in interface Score<BendableScore>

Parameters:

otherScore - never null

Returns:

true if the otherScore is accepted as a parameter of Score.add(Score), Score.subtract(Score) and Comparable.compareTo(Object).