com.io7m.jranges

Class RangeInclusiveB

java.lang.Object

com.io7m.jranges.RangeInclusiveB

@Immutable
public final class RangeInclusiveB
extends Object

Immutable type representing an inclusive range with BigInteger components.

Constructor Summary

Constructors

Constructor and Description
RangeInclusiveB(BigInteger in_lower, BigInteger in_upper) Construct an inclusive range.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
BigInteger	getInterval() Retrieve the number of values in the range [lower, upper].
BigInteger	getLower()
BigInteger	getUpper()
int	hashCode()
boolean	includesValue(BigInteger value) Determine if the given value is included in this range.
boolean	isIncludedIn(RangeInclusiveB other) Determine if the given range is included in this range.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RangeInclusiveB

public RangeInclusiveB(BigInteger in_lower,
                       BigInteger in_upper)

Construct an inclusive range. The constructor enforces the invariant lower <= upper.

Parameters:

in_lower - The lower bound

in_upper - The upper bound

Method Detail

equals

public boolean equals(@Nullable
                      Object obj)

Overrides:

equals in class Object

getInterval

public BigInteger getInterval()

Retrieve the number of values in the range [lower, upper]. That is, (upper - lower) + 1.

Returns:

The number of values in the range

getLower

public BigInteger getLower()

Returns:

The lower bound of the inclusive range.

getUpper

public BigInteger getUpper()

Returns:

The upper bound of the inclusive range.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

includesValue

public boolean includesValue(BigInteger value)

Determine if the given value is included in this range.

Parameters:

value - The given value

Returns:

true iff value >= this.getLower() && value <= this.getUpper() .

isIncludedIn

public boolean isIncludedIn(RangeInclusiveB other)

Determine if the given range is included in this range.

Parameters:

other - The given range

Returns:

true iff this.getLower() >= other.getLower() && this.getUpper() <= other.getUpper() .

toString

public String toString()

Overrides:

toString in class Object