org.optaplanner.core.api.score.buildin.bendablebigdecimal

Class BendableBigDecimalScore

java.lang.Object

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

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

org.optaplanner.core.api.score.buildin.bendablebigdecimal.BendableBigDecimalScore

All Implemented Interfaces:

Serializable, Comparable<BendableBigDecimalScore>, FeasibilityScore<BendableBigDecimalScore>, Score<BendableBigDecimalScore>

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

This Score is based on n levels of BigDecimal 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	BendableBigDecimalScore(int initScore, BigDecimal[] hardScores, BigDecimal[] softScores)

Method Summary

Modifier and Type	Method and Description
BendableBigDecimalScore	add(BendableBigDecimalScore augment) Returns a Score whose value is (this + augment).
int	compareTo(BendableBigDecimalScore other)
BendableBigDecimalScore	divide(double divisor) Returns a Score whose value is (this / divisor).
boolean	equals(Object o)
int	getHardLevelsSize()
BigDecimal	getHardOrSoftScore(int index)
BigDecimal	getHardScore(int index)
int	getLevelsSize()
int	getSoftLevelsSize()
BigDecimal	getSoftScore(int index)
int	hashCode()
boolean	isCompatibleArithmeticArgument(Score otherScore)
boolean	isFeasible() A PlanningSolution is feasible if it has no broken hard constraints and Score.isSolutionInitialized() is true.
BendableBigDecimalScore	multiply(double multiplicand) Returns a Score whose value is (this * multiplicand).
BendableBigDecimalScore	negate() Returns a Score whose value is (- this).
static BendableBigDecimalScore	parseScore(String scoreString)
BendableBigDecimalScore	power(double exponent) Returns a Score whose value is (this ^ exponent).
BendableBigDecimalScore	subtract(BendableBigDecimalScore subtrahend) Returns a Score whose value is (this - subtrahend).
BendableBigDecimalScore	toInitializedScore() For example -7init/0hard/-8soft returns 0hard/-8soft.
Number[]	toLevelNumbers() Returns an array of numbers representing the Score.
String	toString()
void	validateCompatible(BendableBigDecimalScore other)
static BendableBigDecimalScore	valueOf(int initScore, BigDecimal[] hardScores, BigDecimal[] softScores) Creates a new BendableBigDecimalScore.
static BendableBigDecimalScore	valueOfInitialized(BigDecimal[] hardScores, BigDecimal[] softScores) Creates a new BendableBigDecimalScore.

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

parseBendableScoreTokens

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

buildScorePattern, 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

BendableBigDecimalScore

protected BendableBigDecimalScore(int initScore,
                                  BigDecimal[] hardScores,
                                  BigDecimal[] softScores)

Parameters:

initScore - see Score.getInitScore()

hardScores - never null

softScores - never null

Method Detail

parseScore

public static BendableBigDecimalScore parseScore(String scoreString)

Parameters:

scoreString - never null

Returns:

never null

valueOf

public static BendableBigDecimalScore valueOf(int initScore,
                                              BigDecimal[] hardScores,
                                              BigDecimal[] softScores)

Creates a new BendableBigDecimalScore.

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

valueOfInitialized

public static BendableBigDecimalScore valueOfInitialized(BigDecimal[] hardScores,
                                                         BigDecimal[] softScores)

Creates a new BendableBigDecimalScore.

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

getHardLevelsSize

public int getHardLevelsSize()

Specified by:

getHardLevelsSize in class AbstractBendableScore<BendableBigDecimalScore>

Returns:

>= 0

getHardScore

public BigDecimal getHardScore(int index)

Parameters:

index - 0 <= index < getHardLevelsSize()

Returns:

higher is better

getSoftLevelsSize

public int getSoftLevelsSize()

Specified by:

getSoftLevelsSize in class AbstractBendableScore<BendableBigDecimalScore>

Returns:

>= 0

getSoftScore

public BigDecimal getSoftScore(int index)

Parameters:

index - 0 <= index < getSoftLevelsSize()

Returns:

higher is better

toInitializedScore

public BendableBigDecimalScore toInitializedScore()

Description copied from interface: Score

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

Specified by:

toInitializedScore in interface Score<BendableBigDecimalScore>

Returns:

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

getLevelsSize

public int getLevelsSize()

Specified by:

getLevelsSize in class AbstractBendableScore<BendableBigDecimalScore>

Returns:

AbstractBendableScore.getHardLevelsSize() + AbstractBendableScore.getSoftLevelsSize()

getHardOrSoftScore

public BigDecimal getHardOrSoftScore(int index)

Parameters:

index - 0 <= index < 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<BendableBigDecimalScore>

Returns:

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

add

public BendableBigDecimalScore add(BendableBigDecimalScore augment)

Description copied from interface: Score

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

Specified by:

add in interface Score<BendableBigDecimalScore>

Parameters:

augment - value to be added to this Score

Returns:

this + augment

subtract

public BendableBigDecimalScore subtract(BendableBigDecimalScore subtrahend)

Description copied from interface: Score

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

Specified by:

subtract in interface Score<BendableBigDecimalScore>

Parameters:

subtrahend - value to be subtracted from this Score

Returns:

this - subtrahend, rounded as necessary

multiply

public BendableBigDecimalScore 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<BendableBigDecimalScore>

Parameters:

multiplicand - value to be multiplied by this Score.

Returns:

this * multiplicand

divide

public BendableBigDecimalScore 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<BendableBigDecimalScore>

Parameters:

divisor - value by which this Score is to be divided

Returns:

this / divisor

power

public BendableBigDecimalScore 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<BendableBigDecimalScore>

Parameters:

exponent - value by which this Score is to be powered

Returns:

this ^ exponent

negate

public BendableBigDecimalScore negate()

Description copied from interface: Score

Returns a Score whose value is (- this).

Specified by:

negate in interface Score<BendableBigDecimalScore>

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

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(BendableBigDecimalScore other)

Specified by:

compareTo in interface Comparable<BendableBigDecimalScore>

toString

public String toString()

Overrides:

toString in class Object

validateCompatible

public void validateCompatible(BendableBigDecimalScore other)

isCompatibleArithmeticArgument

public boolean isCompatibleArithmeticArgument(Score otherScore)

Specified by:

isCompatibleArithmeticArgument in interface Score<BendableBigDecimalScore>

Overrides:

isCompatibleArithmeticArgument in class AbstractScore<BendableBigDecimalScore>

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).