Package ai.timefold.solver.core.api.domain.valuerange

Interface ValueRange<T>

All Known Subinterfaces:
CountableValueRange<T>
All Known Implementing Classes:
AbstractCountableValueRange, AbstractUncountableValueRange, BigDecimalValueRange, BigIntegerValueRange, BooleanValueRange, CompositeCountableValueRange, DoubleValueRange, EmptyValueRange, IntValueRange, ListValueRange, LongValueRange, NullAllowingCountableValueRange, TemporalValueRange
public interface ValueRange<T>
A ValueRange is a set of a values for a PlanningVariable. These values might be stored in memory as a Collection (usually a List or Set), but if the values are numbers, they can also be stored in memory by their bounds to use less memory and provide more opportunities.

ValueRange is stateful. Implementations must be immutable.

Prefer using CountableValueRange. In a future version of Timefold Solver, uncountable value ranges will not be allowed, and certain recently introduced features already do not support them.

See Also:

  • Method Details

    • isEmpty

      boolean isEmpty()
      In a CountableValueRange, this must be consistent with CountableValueRange.getSize().
      Returns:
      true if the range is empty

    • contains

      boolean contains(@Nullable T value)
      Parameters:
      value - sometimes null
      Returns:
      true if the ValueRange contains that value

    • createRandomIterator

      @NonNull Iterator<T> createRandomIterator(@NonNull Random workingRandom)
      Select in random order, but without shuffling the elements. Each element might be selected multiple times. Scales well because it does not require caching.
      Parameters:
      workingRandom - the Random to use when any random number is needed, so runs are reproducible.