org.optaplanner.core.impl.domain.valuerange.buildin.primint

Class IntValueRange

java.lang.Object

org.optaplanner.core.impl.domain.valuerange.AbstractCountableValueRange<Integer>

org.optaplanner.core.impl.domain.valuerange.buildin.primint.IntValueRange

All Implemented Interfaces:

Serializable, CountableValueRange<Integer>, ValueRange<Integer>

public class IntValueRange
extends AbstractCountableValueRange<Integer>

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IntValueRange(int from, int to)
IntValueRange(int from, int to, int incrementUnit)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(Integer value)
Iterator<Integer>	createOriginalIterator() Select the elements in original (natural) order.
Iterator<Integer>	createRandomIterator(Random workingRandom) Select in random order, but without shuffling the elements.
Integer	get(long index) Used by uniform random selection in a composite or nullable CountableValueRange.
long	getSize() Used by uniform random selection in a composite or nullable CountableValueRange.

Methods inherited from class org.optaplanner.core.impl.domain.valuerange.AbstractCountableValueRange

isEmpty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IntValueRange

public IntValueRange(int from,
             int to)

Parameters:

from - inclusive minimum

to - exclusive maximum, >= from

IntValueRange

public IntValueRange(int from,
             int to,
             int incrementUnit)

Parameters:

from - inclusive minimum

to - exclusive maximum, >= from

incrementUnit - > 0

Method Detail

getSize

public long getSize()

Description copied from interface: CountableValueRange

Used by uniform random selection in a composite or nullable CountableValueRange.

Returns:

the exact number of elements generated by this CountableValueRange, always >= 0

contains

public boolean contains(Integer value)

Parameters:

value - sometimes null

Returns:

true if the ValueRange contains that value

get

public Integer get(long index)

Description copied from interface: CountableValueRange

Used by uniform random selection in a composite or nullable CountableValueRange.

Parameters:

index - always < CountableValueRange.getSize()

Returns:

sometimes null (if PlanningVariable.nullable() is true)

createOriginalIterator

public Iterator<Integer> createOriginalIterator()

Description copied from interface: CountableValueRange

Select the elements in original (natural) order.

Returns:

never null

createRandomIterator

public Iterator<Integer> createRandomIterator(Random workingRandom)

Description copied from interface: ValueRange

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 - never null, the Random to use when any random number is needed, so EnvironmentMode.REPRODUCIBLE works correctly. RandomUtils can be useful too.

Returns:

never null