manifold.collections.api.range

Class BigIntegerRange

java.lang.Object

manifold.collections.api.range.AbstractRange<E,ME>

manifold.collections.api.range.AbstractIterableRange<E,E,Void,ME>

manifold.collections.api.range.NumberRange<BigInteger,BigIntegerRange>

manifold.collections.api.range.BigIntegerRange

All Implemented Interfaces:

Iterable<BigInteger>, IterableRange<BigInteger,BigInteger,Void,BigIntegerRange>, Range<BigInteger,BigIntegerRange>

public final class BigIntegerRange
extends NumberRange<BigInteger,BigIntegerRange>

Constructor Summary

Constructors

Constructor and Description
BigIntegerRange(BigInteger left, BigInteger right)
BigIntegerRange(BigInteger left, BigInteger right, BigInteger step, boolean leftClosed, boolean rightClosed, boolean reverse)

Method Summary

Modifier and Type	Method and Description
BigInteger	getFromLeft(int iStepIndex)
BigInteger	getFromRight(int iStepIndex)
Iterator<BigInteger>	iterateFromLeft()
Iterator<BigInteger>	iterateFromRight()

Methods inherited from class manifold.collections.api.range.AbstractIterableRange

equals, getStep, getUnit, hashCode, iterator, step, toString, unit

Methods inherited from class manifold.collections.api.range.AbstractRange

contains, contains, getLeftEndpoint, getRightEndpoint, isLeftClosed, isReversed, isRightClosed

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface manifold.collections.api.range.Range

contains, contains, getLeftEndpoint, getRightEndpoint, isLeftClosed, isReversed, isRightClosed

Constructor Detail

BigIntegerRange

public BigIntegerRange(BigInteger left,
                       BigInteger right)

BigIntegerRange

public BigIntegerRange(BigInteger left,
                       BigInteger right,
                       BigInteger step,
                       boolean leftClosed,
                       boolean rightClosed,
                       boolean reverse)

Method Detail

iterateFromLeft

public Iterator<BigInteger> iterateFromLeft()

Returns:

An iterator that visits the elements in this range in order, from left to right. Returns null if this range does not support iteration.

See Also:

IterableRange.iterator(), IterableRange.iterateFromRight()

iterateFromRight

public Iterator<BigInteger> iterateFromRight()

Returns:

An iterator that visits the elements in this range in reverse order, from right to left. Returns null if this range does not support iteration.

See Also:

IterableRange.iterator(), IterableRange.iterateFromLeft()

getFromLeft

public BigInteger getFromLeft(int iStepIndex)

Parameters:

iStepIndex - The index of the step from the left endpoint

Returns:

The nth step from the left endpoint. Returns null if iStepIndex is out of bounds.

getFromRight

public BigInteger getFromRight(int iStepIndex)

Parameters:

iStepIndex - The index of the step from the right endpoint

Returns:

The nth step from the right endpoint. Returns null if iStepIndex is out of bounds.