blogspot.software_and_algorithms.stern_library.data_structure

Class Interval<T extends Comparable<T>>

java.lang.Object

blogspot.software_and_algorithms.stern_library.data_structure.Interval<T>

All Implemented Interfaces:

Comparable<Interval<T>>

public class Interval<T extends Comparable<T>>
extends Object
implements Comparable<Interval<T>>

An interval is the subset of elements which fall between (with respect to a total order) two endpoint elements of a set. An interval that contains its endpoints is closed, an interval that contains one of its endpoints but not the other is half open and an interval that does not contain either of its endpoints is open. This class encapsulates the concept of an interval and uses a class's natural order.

Author:

Kevin L. Stern

Constructor Summary

Constructors

Constructor and Description
Interval(T low, boolean isClosedOnLow, T high, boolean isClosedOnHigh) Construct a new instance with the specified low and high endpoints.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Interval<T> o)
boolean	contains(Interval<T> interval) Test whether or not this interval contains the specified interval.
boolean	contains(T value) Test whether or not this interval contains the specified value.
boolean	equals(Object obj)
T	getHigh() Get the high endpoint.
T	getLow() Get the low endpoint.
int	hashCode()
boolean	isClosedOnHigh()
boolean	isClosedOnLow()
boolean	overlaps(Interval<T> interval) Test whether or not this interval and the specified interval overlap.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Interval

public Interval(T low,
                boolean isClosedOnLow,
                T high,
                boolean isClosedOnHigh)

Construct a new instance with the specified low and high endpoints.

Parameters:

low - the low endpoint.

isClosedOnLow - true if this interval contains its low endpoint, false otherwise.

high - the high endpoint.

isClosedOnHigh - true if this interval contains its high endpoint, false otherwise.

Method Detail

compareTo

public int compareTo(Interval<T> o)

Specified by:

compareTo in interface Comparable<Interval<T extends Comparable<T>>>

contains

public boolean contains(Interval<T> interval)

Test whether or not this interval contains the specified interval. An interval is contained by another precisely when all of its values are contained by the other.

Parameters:

interval - the query interval, non-null.

Returns:

true if this interval contains the specified interval, false otherwise.

contains

public boolean contains(T value)

Test whether or not this interval contains the specified value.

Parameters:

value - the query value, non-null.

Returns:

true if this interval contains the specified value, false otherwise.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getHigh

public T getHigh()

Get the high endpoint.

Returns:

the high endpoint.

getLow

public T getLow()

Get the low endpoint.

Returns:

the low endpoint.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isClosedOnHigh

public boolean isClosedOnHigh()

Returns:

true if this interval is closed at its high endpoint, false otherwise.

isClosedOnLow

public boolean isClosedOnLow()

Returns:

true if the interval is closed at its low endpoint, false otherwise.

overlaps

public boolean overlaps(Interval<T> interval)

Test whether or not this interval and the specified interval overlap. Two intervals overlap precisely when their intersection is non-empty.

Parameters:

interval - the query interval.

Returns:

true if this interval and the specified interval overlap, false otherwise.

toString

public String toString()

Overrides:

toString in class Object