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

Class BendableBigDecimalScore

java.lang.Object

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

All Implemented Interfaces:

Serializable, Comparable<BendableBigDecimalScore>, IBendableScore<BendableBigDecimalScore>, Score<BendableBigDecimalScore>

public final class BendableBigDecimalScore
extends Object
implements IBendableScore<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 hardLevelsSize() and softLevelsSize() must be the same as in the BendableScoreDefinition used.

See Also:

• Score
• Serialized Form

Method Summary

Modifier and Type	Method	Description
BendableBigDecimalScore	abs()	Returns a Score whose value is the absolute value of the score, i.e.
BendableBigDecimalScore	add(BendableBigDecimalScore addend)	Returns a Score whose value is (this + addend).
int	compareTo(BendableBigDecimalScore other)
BendableBigDecimalScore	divide(double divisor)	Returns a Score whose value is (this / divisor).
boolean	equals(Object o)
BigDecimal	getHardOrSoftScore(int index)	Deprecated, for removal: This API element is subject to removal in a future version. Use hardOrSoftScore(int) instead.
BigDecimal	getHardScore(int index)	Deprecated, for removal: This API element is subject to removal in a future version. Use hardScore(int) instead.
BigDecimal[]	getHardScores()	Deprecated, for removal: This API element is subject to removal in a future version. Use hardScores() instead.
BigDecimal	getSoftScore(int index)	Deprecated, for removal: This API element is subject to removal in a future version. Use softScore(int) instead.
BigDecimal[]	getSoftScores()	Deprecated, for removal: This API element is subject to removal in a future version. Use softScores() instead.
int	hardLevelsSize()	The sum of this and IBendableScore.softLevelsSize() equals IBendableScore.levelsSize().
BigDecimal	hardOrSoftScore(int index)
BigDecimal	hardScore(int index)
BigDecimal[]	hardScores()
int	hashCode()
int	initScore()	The init score is the negative of the number of uninitialized genuine planning variables.
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	of(BigDecimal[] hardScores, BigDecimal[] softScores)	Creates a new BendableBigDecimalScore.
static BendableBigDecimalScore	ofHard(int hardLevelsSize, int softLevelsSize, int hardLevel, BigDecimal hardScore)	Creates a new BendableBigDecimalScore.
static BendableBigDecimalScore	ofSoft(int hardLevelsSize, int softLevelsSize, int softLevel, BigDecimal softScore)	Creates a new BendableBigDecimalScore.
static BendableBigDecimalScore	ofUninitialized(int initScore, BigDecimal[] hardScores, BigDecimal[] softScores)	Creates a new BendableBigDecimalScore.
static BendableBigDecimalScore	parseScore(String scoreString)
BendableBigDecimalScore	power(double exponent)	Returns a Score whose value is (this ^ exponent).
int	softLevelsSize()	The sum of IBendableScore.hardLevelsSize() and this equals IBendableScore.levelsSize().
BigDecimal	softScore(int index)
BigDecimal[]	softScores()
BendableBigDecimalScore	subtract(BendableBigDecimalScore subtrahend)	Returns a Score whose value is (this - subtrahend).
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(BendableBigDecimalScore other)
BendableBigDecimalScore	withInitScore(int newInitScore)	For example 0hard/-8soft with -7 returns -7init/0hard/-8soft.
BendableBigDecimalScore	zero()	Returns a Score, all levels of which are zero.
static BendableBigDecimalScore	zero(int hardLevelsSize, int softLevelsSize)	Creates a new BendableBigDecimalScore.

Methods inherited from class java.lang.Object

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

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

getHardLevelsSize, getLevelsSize, getSoftLevelsSize, levelsSize

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

getInitScore, isSolutionInitialized, isZero, toLevelDoubles

Method Details

parseScore

public static BendableBigDecimalScore parseScore(String scoreString)

Parameters:

scoreString - never null

Returns:

never null

ofUninitialized

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

Creates a new BendableBigDecimalScore.

Parameters:

initScore - see Score.initScore()

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

of

public static BendableBigDecimalScore of(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

zero

public static BendableBigDecimalScore zero(int hardLevelsSize,
 int softLevelsSize)

Creates a new BendableBigDecimalScore.

Parameters:

hardLevelsSize - at least 0

softLevelsSize - at least 0

Returns:

never null

ofHard

public static BendableBigDecimalScore ofHard(int hardLevelsSize,
 int softLevelsSize,
 int hardLevel,
 BigDecimal hardScore)

Creates a new BendableBigDecimalScore.

Parameters:

hardLevelsSize - at least 0

softLevelsSize - at least 0

hardLevel - at least 0, less than hardLevelsSize

hardScore - never null

Returns:

never null

ofSoft

public static BendableBigDecimalScore ofSoft(int hardLevelsSize,
 int softLevelsSize,
 int softLevel,
 BigDecimal softScore)

Creates a new BendableBigDecimalScore.

Parameters:

hardLevelsSize - at least 0

softLevelsSize - at least 0

softLevel - at least 0, less than softLevelsSize

softScore - never null

Returns:

never null

initScore

public int initScore()

Description copied from interface: Score

The init score is the negative of the number of uninitialized genuine planning variables. If it's 0 (which it usually is), the PlanningSolution is fully initialized and the score's Object.toString() does not mention it.

During Comparable.compareTo(Object), it's even more important than the hard score: if you don't want this behaviour, read about overconstrained planning in the reference manual.

Specified by:

initScore in interface Score<BendableBigDecimalScore>

Returns:

higher is better, always negative (except in statistical calculations), 0 if all planning variables are initialized

hardScores

public BigDecimal[] hardScores()

Returns:

not null, array copy because this class is immutable

getHardScores

@Deprecated(forRemoval=true)
public BigDecimal[] getHardScores()

Deprecated, for removal: This API element is subject to removal in a future version.

Use hardScores() instead.

As defined by hardScores().

softScores

public BigDecimal[] softScores()

Returns:

not null, array copy because this class is immutable

getSoftScores

@Deprecated(forRemoval=true)
public BigDecimal[] getSoftScores()

Deprecated, for removal: This API element is subject to removal in a future version.

Use softScores() instead.

As defined by softScores().

hardLevelsSize

public int hardLevelsSize()

Description copied from interface: IBendableScore

The sum of this and IBendableScore.softLevelsSize() equals IBendableScore.levelsSize().

Specified by:

hardLevelsSize in interface IBendableScore<BendableBigDecimalScore>

Returns:

>= 0 and < IBendableScore.levelsSize()

hardScore

public BigDecimal hardScore(int index)

Parameters:

index - 0 <= index < hardLevelsSize()

Returns:

higher is better

getHardScore

@Deprecated(forRemoval=true)
public BigDecimal getHardScore(int index)

Deprecated, for removal: This API element is subject to removal in a future version.

Use hardScore(int) instead.

As defined by hardScore(int).

softLevelsSize

public int softLevelsSize()

Description copied from interface: IBendableScore

The sum of IBendableScore.hardLevelsSize() and this equals IBendableScore.levelsSize().

Specified by:

softLevelsSize in interface IBendableScore<BendableBigDecimalScore>

Returns:

>= 0 and < IBendableScore.levelsSize()

softScore

public BigDecimal softScore(int index)

Parameters:

index - 0 <= index < softLevelsSize()

Returns:

higher is better

getSoftScore

@Deprecated(forRemoval=true)
public BigDecimal getSoftScore(int index)

Deprecated, for removal: This API element is subject to removal in a future version.

Use softScore(int) instead.

As defined by softScore(int).

withInitScore

public BendableBigDecimalScore withInitScore(int newInitScore)

Description copied from interface: Score

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

Specified by:

withInitScore in interface Score<BendableBigDecimalScore>

Parameters:

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

Returns:

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

hardOrSoftScore

public BigDecimal hardOrSoftScore(int index)

Parameters:

index - 0 <= index < IBendableScore.levelsSize()

Returns:

higher is better

getHardOrSoftScore

@Deprecated(forRemoval=true)
public BigDecimal getHardOrSoftScore(int index)

Deprecated, for removal: This API element is subject to removal in a future version.

Use hardOrSoftScore(int) instead.

As defined by hardOrSoftScore(int).

isFeasible

public boolean isFeasible()

Description copied from interface: Score

A PlanningSolution is feasible if it has no broken hard constraints and Score.isSolutionInitialized() is true. Simple scores (SimpleScore, SimpleLongScore, SimpleBigDecimalScore) are always feasible, if their Score.initScore() is 0.

Specified by:

isFeasible in interface Score<BendableBigDecimalScore>

Returns:

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

add

public BendableBigDecimalScore add(BendableBigDecimalScore addend)

Description copied from interface: Score

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

Specified by:

add in interface Score<BendableBigDecimalScore>

Parameters:

addend - value to be added to this Score

Returns:

this + addend

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

abs

public BendableBigDecimalScore abs()

Description copied from interface: Score

Returns a Score whose value is the absolute value of the score, i.e. |this|.

Specified by:

abs in interface Score<BendableBigDecimalScore>

Returns:

never null

zero

public BendableBigDecimalScore zero()

Description copied from interface: Score

Returns a Score, all levels of which are zero.

Specified by:

zero in interface Score<BendableBigDecimalScore>

Returns:

never null

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.initScore(). For example: -3init/-0hard/-7soft also returns new int{-0, -7}

Specified by:

toLevelNumbers in interface Score<BendableBigDecimalScore>

Returns:

never null

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>

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

Returns:

never null

toString

public String toString()

Overrides:

toString in class Object

validateCompatible

public void validateCompatible(BendableBigDecimalScore other)