manifold.collections.api.range

Class BigDecimalRange

java.lang.Object

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

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

manifold.collections.api.range.NumberRange<BigDecimal,BigDecimalRange>

manifold.collections.api.range.BigDecimalRange

All Implemented Interfaces:

Iterable<BigDecimal>, IterableRange<BigDecimal,BigDecimal,Void,BigDecimalRange>, Range<BigDecimal,BigDecimalRange>

public final class BigDecimalRange
extends NumberRange<BigDecimal,BigDecimalRange>

Constructor Summary

Constructors

Constructor and Description
BigDecimalRange(BigDecimal left, BigDecimal right)
BigDecimalRange(BigDecimal left, BigDecimal right, BigDecimal step, boolean leftClosed, boolean rightClosed, boolean reverse)

Method Summary

Modifier and Type	Method and Description
BigDecimal	getFromLeft(int iStepIndex)
BigDecimal	getFromRight(int iStepIndex)
Iterator<BigDecimal>	iterateFromLeft()
Iterator<BigDecimal>	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

BigDecimalRange

public BigDecimalRange(BigDecimal left,
                       BigDecimal right)

BigDecimalRange

public BigDecimalRange(BigDecimal left,
                       BigDecimal right,
                       BigDecimal step,
                       boolean leftClosed,
                       boolean rightClosed,
                       boolean reverse)

Method Detail

iterateFromLeft

public Iterator<BigDecimal> 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<BigDecimal> 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 BigDecimal 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 BigDecimal 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.