Package ai.timefold.solver.core.api.score

Interface IBendableScore<Score_ extends IBendableScore<Score_>>

Type Parameters:

Score_ - the actual score type to allow addition, subtraction and other arithmetic

All Superinterfaces:

Comparable<Score_>, Score<Score_>, Serializable

All Known Implementing Classes:

AbstractBendableScore, BendableBigDecimalScore, BendableLongScore, BendableScore

@NullMarked
public interface IBendableScore<Score_ extends IBendableScore<Score_>>
extends Score<Score_>, Serializable

Bendable score is a Score whose hardLevelsSize() and softLevelsSize() are only known at runtime.

Interfaces in Timefold are usually not prefixed with "I". However, the conflict in name with its implementation (BendableScore) made this necessary. All the other options were considered worse, some even harmful. This is a minor issue, as users will access the implementation and not the interface anyway.

Method Summary

Modifier and Type	Method	Description
default int	getHardLevelsSize()	Deprecated, for removal: This API element is subject to removal in a future version. Use hardLevelsSize() instead.
default int	getLevelsSize()	Deprecated, for removal: This API element is subject to removal in a future version. Use levelsSize() instead.
default int	getSoftLevelsSize()	Deprecated, for removal: This API element is subject to removal in a future version. Use softLevelsSize() instead.
int	hardLevelsSize()	The sum of this and softLevelsSize() equals levelsSize().
default int	levelsSize()
int	softLevelsSize()	The sum of hardLevelsSize() and this equals levelsSize().

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface ai.timefold.solver.core.api.score.Score

abs, add, divide, getInitScore, initScore, isFeasible, isSolutionInitialized, isZero, multiply, negate, power, subtract, toLevelDoubles, toLevelNumbers, toShortString, withInitScore, zero

Method Details

hardLevelsSize

int hardLevelsSize()

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

Returns:

>= 0 and < levelsSize()

getHardLevelsSize

@Deprecated(forRemoval=true)
default int getHardLevelsSize()

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

Use hardLevelsSize() instead.

As defined by hardLevelsSize().

softLevelsSize

int softLevelsSize()

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

Returns:

>= 0 and < levelsSize()

getSoftLevelsSize

@Deprecated(forRemoval=true)
default int getSoftLevelsSize()

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

Use softLevelsSize() instead.

As defined by softLevelsSize().

levelsSize

default int levelsSize()

Returns:

hardLevelsSize() + softLevelsSize()

getLevelsSize

@Deprecated(forRemoval=true)
default int getLevelsSize()

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

Use levelsSize() instead.

As defined by levelsSize().