Package org.optaplanner.core.impl.domain.valuerange.buildin.biginteger

Class BigIntegerValueRange

java.lang.Object

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

org.optaplanner.core.impl.domain.valuerange.buildin.biginteger.BigIntegerValueRange

All Implemented Interfaces:

CountableValueRange<BigInteger>, ValueRange<BigInteger>

public class BigIntegerValueRange
extends AbstractCountableValueRange<BigInteger>

Constructor Summary

Constructors

Constructor	Description
BigIntegerValueRange(BigInteger from, BigInteger to)
BigIntegerValueRange(BigInteger from, BigInteger to, BigInteger incrementUnit)

Method Summary

Modifier and Type	Method	Description
boolean	contains(BigInteger value)
Iterator<BigInteger>	createOriginalIterator()	Select the elements in original (natural) order.
Iterator<BigInteger>	createRandomIterator(Random workingRandom)	Select in random order, but without shuffling the elements.
BigInteger	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.
String	toString()

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, wait, wait, wait

Constructor Detail

BigIntegerValueRange

public BigIntegerValueRange(BigInteger from,
                            BigInteger to)

Parameters:

from - never null, inclusive minimum

to - never null, exclusive maximum, >= from

BigIntegerValueRange

public BigIntegerValueRange(BigInteger from,
                            BigInteger to,
                            BigInteger incrementUnit)

Parameters:

from - never null, inclusive minimum

to - never null, exclusive maximum, >= from

incrementUnit - never null, > 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

get

public BigInteger 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)

contains

public boolean contains(BigInteger value)

Parameters:

value - sometimes null

Returns:

true if the ValueRange contains that value

createOriginalIterator

public Iterator<BigInteger> createOriginalIterator()

Description copied from interface: CountableValueRange

Select the elements in original (natural) order.

Returns:

never null

createRandomIterator

public Iterator<BigInteger> 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 runs are reproducible.

Returns:

never null

toString

public String toString()

Overrides:

toString in class Object