OptaPlanner core 6.2.0.Beta1

org.optaplanner.core.api.score.buildin.hardsoftlong
Class HardSoftLongScore

java.lang.Object
  extended by org.optaplanner.core.api.score.AbstractScore<HardSoftLongScore>
      extended by org.optaplanner.core.api.score.buildin.hardsoftlong.HardSoftLongScore
All Implemented Interfaces:
Serializable, Comparable<HardSoftLongScore>, FeasibilityScore<HardSoftLongScore>, Score<HardSoftLongScore>

public final class HardSoftLongScore
extends AbstractScore<HardSoftLongScore>
implements FeasibilityScore<HardSoftLongScore>

This Score is based on 2 levels of long constraints: hard and soft. Hard constraints have priority over soft constraints.

This class is immutable.

See Also:
Score, Serialized Form

Method Summary
 HardSoftLongScore add(HardSoftLongScore augment)
          Returns a Score whose value is (this + augment).
 int compareTo(HardSoftLongScore other)
           
 HardSoftLongScore divide(double divisor)
          Returns a Score whose value is (this / divisor).
 boolean equals(Object o)
           
 long getHardScore()
          The total of the broken negative hard constraints and fulfilled positive hard constraints.
 long getSoftScore()
          The total of the broken negative soft constraints and fulfilled positive soft constraints.
 int hashCode()
           
 boolean isFeasible()
          A Solution is feasible if it has no broken hard constraints.
 HardSoftLongScore multiply(double multiplicand)
          Returns a Score whose value is (this * multiplicand).
 HardSoftLongScore negate()
          Returns a Score whose value is (- this).
static HardSoftLongScore parseScore(String scoreString)
           
 HardSoftLongScore power(double exponent)
          Returns a Score whose value is (this ^ exponent).
 HardSoftLongScore subtract(HardSoftLongScore subtrahend)
          Returns a Score whose value is (this - subtrahend).
 Number[] toLevelNumbers()
          Returns an array of numbers representing the Score.
 String toString()
           
static HardSoftLongScore valueOf(long hardScore, long softScore)
           
 
Methods inherited from class org.optaplanner.core.api.score.AbstractScore
buildScorePattern, buildScorePattern, isCompatibleArithmeticArgument, parseLevelAsBigDecimal, parseLevelAsDouble, parseLevelAsInt, parseLevelAsLong, parseLevelStrings, parseLevelStrings
 
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
isCompatibleArithmeticArgument
 

Method Detail

parseScore

public static HardSoftLongScore parseScore(String scoreString)

valueOf

public static HardSoftLongScore valueOf(long hardScore,
                                        long softScore)

getHardScore

public long getHardScore()
The total of the broken negative hard constraints and fulfilled positive hard constraints. Their weight is included in the total. The hard score is usually a negative number because most use cases only have negative constraints.

Returns:
higher is better, usually negative, 0 if no hard constraints are broken/fulfilled

getSoftScore

public long getSoftScore()
The total of the broken negative soft constraints and fulfilled positive soft constraints. Their weight is included in the total. The soft score is usually a negative number because most use cases only have negative constraints.

In a normal score comparison, the soft score is irrelevant if the 2 scores don't have the same hard score.

Returns:
higher is better, usually negative, 0 if no soft constraints are broken/fulfilled

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<HardSoftLongScore>
Returns:
true if the hard score(s) is 0 or higher

add

public HardSoftLongScore add(HardSoftLongScore augment)
Description copied from interface: Score
Returns a Score whose value is (this + augment).

Specified by:
add in interface Score<HardSoftLongScore>
Parameters:
augment - value to be added to this Score
Returns:
this + augment

subtract

public HardSoftLongScore subtract(HardSoftLongScore subtrahend)
Description copied from interface: Score
Returns a Score whose value is (this - subtrahend).

Specified by:
subtract in interface Score<HardSoftLongScore>
Parameters:
subtrahend - value to be subtracted from this Score
Returns:
this - subtrahend, rounded as necessary

multiply

public HardSoftLongScore 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<HardSoftLongScore>
Parameters:
multiplicand - value to be multiplied by this Score.
Returns:
this * multiplicand

divide

public HardSoftLongScore 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<HardSoftLongScore>
Parameters:
divisor - value by which this Score is to be divided
Returns:
this / divisor

power

public HardSoftLongScore 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<HardSoftLongScore>
Parameters:
exponent - value by which this Score is to be powered
Returns:
this ^ exponent

negate

public HardSoftLongScore negate()
Description copied from interface: Score
Returns a Score whose value is (- this).

Specified by:
negate in interface Score<HardSoftLongScore>
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<HardSoftLongScore>
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(HardSoftLongScore other)
Specified by:
compareTo in interface Comparable<HardSoftLongScore>

toString

public String toString()
Overrides:
toString in class Object

OptaPlanner core 6.2.0.Beta1

Copyright © 2006-2014 JBoss by Red Hat. All Rights Reserved.