com.io7m.jranges

Class RangeInclusiveD

java.lang.Object

com.io7m.jranges.RangeInclusiveD

@Immutable
public final class RangeInclusiveD
extends Object

Immutable type representing an inclusive range with double components.

Constructor Summary

Constructors

Constructor and Description
RangeInclusiveD(double in_lower, double in_upper) Construct an inclusive range.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
double	getInterval()
double	getLower()
double	getUpper()
int	hashCode()
boolean	includesValue(double value) Determine if the given value is included in this range.
boolean	isIncludedIn(RangeInclusiveD 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

RangeInclusiveD

public RangeInclusiveD(double in_lower,
                       double 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 double getInterval()

Returns:

The difference between the upper and lower bound, literally upper - lower.

getLower

public double getLower()

Returns:

The lower bound of the inclusive range.

getUpper

public double getUpper()

Returns:

The upper bound of the inclusive range.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

includesValue

public boolean includesValue(double 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(RangeInclusiveD 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