edu.stanford.math.plex4.homology.barcodes

Class Interval<T extends java.lang.Comparable<T>>

java.lang.Object

edu.stanford.math.plex4.homology.barcodes.Interval<T>

Type Parameters:

T - the underlying type - e.g. most likely Integer, Double, or Float

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Interval<T>>

public class Interval<T extends java.lang.Comparable<T>>
extends java.lang.Object
implements java.lang.Comparable<Interval<T>>, java.io.Serializable

This class implements the functionality of an interval of values of any comparable type. It supports finite, semi-infinite, and infinite intervals with open or closed end points.

Author:

Andrew Tausz

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Interval<T> arg0)
int	compareTo2(Interval<T> arg0)
boolean	containsPoint(T point) This function determines whether the given point is a member of the interval.
boolean	equals(java.lang.Object obj)
T	getEnd() This function returns the end of the interval.
T	getStart() This function returns the start of the interval.
int	hashCode()
boolean	isInfinite() This function indicates whether the interval is infinite (either left or right infinite, or both).
boolean	isLeftClosed() This function indicates whether the interval is closed on the left.
boolean	isLeftInfinite() This function indicates whether the interval is left-infinite.
boolean	isRightClosed() This function indicates whether the interval is closed on the right.
boolean	isRightInfinite() This function indicates whether the interval is right-infinite.
static <T extends java.lang.Comparable<T>> Interval<T>	makeFiniteClosedInterval(T start, T end) This function returns a finite closed interval.
static <T extends java.lang.Comparable<T>> Interval<T>	makeFiniteLeftOpenInterval(T start, T end) This function returns a finite left-open interval.
static <T extends java.lang.Comparable<T>> Interval<T>	makeFiniteOpenInterval(T start, T end) This function returns a finite open interval.
static <T extends java.lang.Comparable<T>> Interval<T>	makeFiniteRightOpenInterval(T start, T end) This function returns a finite right-open interval.
static <T extends java.lang.Comparable<T>> Interval<T>	makeInterval(T start, T end, boolean isLeftClosed, boolean isRightClosed, boolean isLeftInfinite, boolean isRightInfinite) This function returns an interval with the desired parameters.
static <T extends java.lang.Comparable<T>> Interval<T>	makeLeftInfiniteClosedInterval(T end) This function returns a left-infinite closed interval.
static <T extends java.lang.Comparable<T>> Interval<T>	makeLeftInfiniteLeftOpenInterval(T end) This function returns a left-infinite left-open interval.
static <T extends java.lang.Comparable<T>> Interval<T>	makeLeftInfiniteOpenInterval(T end) This function returns a left-infinite open interval.
static <T extends java.lang.Comparable<T>> Interval<T>	makeLeftInfiniteRightOpenInterval(T end) This function returns a left-infinite right-open interval.
static <T extends java.lang.Comparable<T>> Interval<T>	makeRightInfiniteClosedInterval(T start) This function returns a right-infinite closed interval.
static <T extends java.lang.Comparable<T>> Interval<T>	makeRightInfiniteLeftOpenInterval(T start) This function returns a right-infinite left-open interval.
static <T extends java.lang.Comparable<T>> Interval<T>	makeRightInfiniteOpenInterval(T start) This function returns a right-infinite open interval.
static <T extends java.lang.Comparable<T>> Interval<T>	makeRightInfiniteRightOpenInterval(T start) This function returns a right-infinite right-open interval.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

makeFiniteClosedInterval

public static <T extends java.lang.Comparable<T>> Interval<T> makeFiniteClosedInterval(T start,
                                                                       T end)

This function returns a finite closed interval.

Type Parameters:

T -

Parameters:

start -

end -

Returns:

a finite closed interval

makeFiniteRightOpenInterval

public static <T extends java.lang.Comparable<T>> Interval<T> makeFiniteRightOpenInterval(T start,
                                                                          T end)

This function returns a finite right-open interval.

Type Parameters:

T -

Parameters:

start -

end -

Returns:

a finite right-open interval

makeFiniteLeftOpenInterval

public static <T extends java.lang.Comparable<T>> Interval<T> makeFiniteLeftOpenInterval(T start,
                                                                         T end)

This function returns a finite left-open interval.

Type Parameters:

T -

Parameters:

start -

end -

Returns:

a finite left-open interval

makeFiniteOpenInterval

public static <T extends java.lang.Comparable<T>> Interval<T> makeFiniteOpenInterval(T start,
                                                                     T end)

This function returns a finite open interval.

Type Parameters:

T -

Parameters:

start -

end -

Returns:

a finite open interval

makeRightInfiniteClosedInterval

public static <T extends java.lang.Comparable<T>> Interval<T> makeRightInfiniteClosedInterval(T start)

This function returns a right-infinite closed interval.

Type Parameters:

T -

Parameters:

start -

Returns:

a right-infinite closed interval

makeRightInfiniteRightOpenInterval

public static <T extends java.lang.Comparable<T>> Interval<T> makeRightInfiniteRightOpenInterval(T start)

This function returns a right-infinite right-open interval.

Type Parameters:

T -

Parameters:

start -

Returns:

a right-infinite right-open interval

makeRightInfiniteLeftOpenInterval

public static <T extends java.lang.Comparable<T>> Interval<T> makeRightInfiniteLeftOpenInterval(T start)

This function returns a right-infinite left-open interval.

Type Parameters:

T -

Parameters:

start -

Returns:

a right-infinite left-open interval

makeRightInfiniteOpenInterval

public static <T extends java.lang.Comparable<T>> Interval<T> makeRightInfiniteOpenInterval(T start)

This function returns a right-infinite open interval.

Type Parameters:

T -

Parameters:

start -

Returns:

a right-infinite open interval

makeLeftInfiniteClosedInterval

public static <T extends java.lang.Comparable<T>> Interval<T> makeLeftInfiniteClosedInterval(T end)

This function returns a left-infinite closed interval.

Type Parameters:

T -

Parameters:

end -

Returns:

a left-infinite closed interval

makeLeftInfiniteRightOpenInterval

public static <T extends java.lang.Comparable<T>> Interval<T> makeLeftInfiniteRightOpenInterval(T end)

This function returns a left-infinite right-open interval.

Type Parameters:

T -

Parameters:

end -

Returns:

a left-infinite right-open interval

makeLeftInfiniteLeftOpenInterval

public static <T extends java.lang.Comparable<T>> Interval<T> makeLeftInfiniteLeftOpenInterval(T end)

This function returns a left-infinite left-open interval.

Type Parameters:

T -

Parameters:

end -

Returns:

a left-infinite left-open interval

makeLeftInfiniteOpenInterval

public static <T extends java.lang.Comparable<T>> Interval<T> makeLeftInfiniteOpenInterval(T end)

This function returns a left-infinite open interval.

Type Parameters:

T -

Parameters:

end -

Returns:

a left-infinite open interval

makeInterval

public static <T extends java.lang.Comparable<T>> Interval<T> makeInterval(T start,
                                                           T end,
                                                           boolean isLeftClosed,
                                                           boolean isRightClosed,
                                                           boolean isLeftInfinite,
                                                           boolean isRightInfinite)

This function returns an interval with the desired parameters.

Type Parameters:

T -

Parameters:

start -

end -

isLeftClosed -

isRightClosed -

isLeftInfinite -

isRightInfinite -

Returns:

an interval specified by the given parameters

getStart

public T getStart()

This function returns the start of the interval.

Returns:

the starting point

getEnd

public T getEnd()

This function returns the end of the interval.

Returns:

the end point

isLeftClosed

public boolean isLeftClosed()

This function indicates whether the interval is closed on the left.

Returns:

true if the interval is closed on the left, and false otherwise

isRightClosed

public boolean isRightClosed()

This function indicates whether the interval is closed on the right.

Returns:

true if the interval is closed on the right, and false otherwise

isLeftInfinite

public boolean isLeftInfinite()

This function indicates whether the interval is left-infinite.

Returns:

true if the interval is left-infinite and false otherwise

isRightInfinite

public boolean isRightInfinite()

This function indicates whether the interval is right-infinite.

Returns:

true if the interval is right-infinite and false otherwise

isInfinite

public boolean isInfinite()

This function indicates whether the interval is infinite (either left or right infinite, or both).

Returns:

true if the interval is infinite, and false otherwise

containsPoint

public boolean containsPoint(T point)

This function determines whether the given point is a member of the interval.

Parameters:

point - the point to test

Returns:

true if the point is in the interval and false otherwise

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(Interval<T> arg0)

Specified by:

compareTo in interface java.lang.Comparable<Interval<T extends java.lang.Comparable<T>>>

compareTo2

public int compareTo2(Interval<T> arg0)