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

Class SimpleScore

    • Method Detail

      • ofUninitialized

        public static SimpleScore ofUninitialized​(int initScore,
                                          int score)

      • getScore

        public int getScore()
        The total of the broken negative constraints and fulfilled positive constraints. Their weight is included in the total. The score is usually a negative number because most use cases only have negative constraints.
        Returns:
        higher is better, usually negative, 0 if no constraints are broken/fulfilled

      • withInitScore

        public SimpleScore withInitScore​(int newInitScore)
        Description copied from interface: Score
        For example 0hard/-8soft with -7 returns -7init/0hard/-8soft.
        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

      • add

        public SimpleScore add​(SimpleScore addend)
        Description copied from interface: Score
        Returns a Score whose value is (this + addend).
        Parameters:
        addend - value to be added to this Score
        Returns:
        this + addend

      • subtract

        public SimpleScore subtract​(SimpleScore subtrahend)
        Description copied from interface: Score
        Returns a Score whose value is (this - subtrahend).
        Parameters:
        subtrahend - value to be subtracted from this Score
        Returns:
        this - subtrahend, rounded as necessary

      • multiply

        public SimpleScore 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.

        Parameters:
        multiplicand - value to be multiplied by this Score.
        Returns:
        this * multiplicand

      • divide

        public SimpleScore 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.

        Parameters:
        divisor - value by which this Score is to be divided
        Returns:
        this / divisor

      • power

        public SimpleScore 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.

        Parameters:
        exponent - value by which this Score is to be powered
        Returns:
        this ^ exponent

      • negate

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

      • zero

        public SimpleScore zero()
        Description copied from interface: Score
        Returns a Score, all levels of which are zero.
        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.getInitScore(). For example: -3init/-0hard/-7soft also returns new int{-0, -7}

        Returns:
        never null

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • compareTo

        public int compareTo​(SimpleScore other)

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

        Returns:
        never null