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

java.lang.Object
  org.optaplanner.core.api.score.AbstractScore<BendableScore>
      org.optaplanner.core.api.score.buildin.bendable.BendableScore

All Implemented Interfaces:

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

public final class BendableScore
extends AbstractScore<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

Constructor Summary

protected

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

Method Summary

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()
int	getHardScore(int index)
int	getSoftLevelsSize()
int	getSoftScore(int index)
int	hashCode()
boolean	isCompatibleArithmeticArgument(Score otherScore)
boolean	isFeasible() A Solution is feasible if it has no broken hard constraints.
BendableScore	multiply(double multiplicand) Returns a Score whose value is (this * multiplicand).
BendableScore	negate() Returns a Score whose value is (- this).
static BendableScore	parseScore(int hardLevelsSize, int softLevelsSize, 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).
Number[]	toLevelNumbers() Returns an array of numbers representing the Score.
String	toString()
void	validateCompatible(BendableScore other)
static BendableScore	valueOf(int[] hardScores, int[] softScores) Creates a new BendableScore.

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

buildScorePattern, buildScorePattern, parseLevelAsBigDecimal, parseLevelAsDouble, parseLevelAsInt, parseLevelAsLong, parseLevelStrings, parseLevelStrings

Methods inherited from class java.lang.Object

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

Constructor Detail

BendableScore

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

Method Detail

parseScore

public static BendableScore parseScore(int hardLevelsSize,
                                       int softLevelsSize,
                                       String scoreString)

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

getHardLevelsSize

public int getHardLevelsSize()

getHardScore

public int getHardScore(int index)

Parameters:

index - 0 <= index < getHardLevelsSize()

Returns:

higher is better

getSoftLevelsSize

public int getSoftLevelsSize()

getSoftScore

public int getSoftScore(int index)

Parameters:

index - 0 <= index < getSoftLevelsSize()

Returns:

higher is better

isFeasible

public boolean isFeasible()

Description copied from interface: FeasibilityScore

A Solution is feasible if it has no broken hard constraints.

Specified by:

isFeasible in interface FeasibilityScore<BendableScore>

Returns:

true if the hard score(s) is 0 or higher

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}

Specified by:

toLevelNumbers in interface Score<BendableScore>

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

Specified by:

compareTo in interface Comparable<BendableScore>

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>

Overrides:

isCompatibleArithmeticArgument in class AbstractScore<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).