broad.core.datastructures.Interval Interface Reference

Inheritance diagram for broad.core.datastructures.Interval:

Classes
class	Impl

Public Member Functions
int	getStart ()
int	getEnd ()
int	getLength ()
int	getRelationship (Interval interval)
boolean	isAdjacent (Interval interval)

Static Public Attributes
static final int	HAS_LESSER_PART = 1
static final int	HAS_OVERLAPPING_PART = 2
static final int	HAS_GREATER_PART = 4
static final int	IS_ADJACENT_AND_EMPTY = 0
static final int	IS_STRICTLY_LESS = HAS_LESSER_PART
static final int	IS_SUBSET = HAS_OVERLAPPING_PART
static final int	IS_LEFT_OVERHANGING_OVERLAPPER = HAS_LESSER_PART | HAS_OVERLAPPING_PART
static final int	IS_STRICTLY_GREATER = HAS_GREATER_PART
static final int	IS_RIGHT_OVERHANGING_OVERLAPPER = HAS_GREATER_PART | HAS_OVERLAPPING_PART
static final int	IS_SUPERSET = HAS_LESSER_PART | HAS_OVERLAPPING_PART | HAS_GREATER_PART

Detailed Description

Semi-open interval on the integer number line. Turf covered runs from the start value inclusive, up to, but not including, the end value.

Author

tsharpe

Version

Revision

74570

Member Function Documentation

int broad.core.datastructures.Interval.getEnd

(

)

Returns the ending point of the interval. The interval is not regarded as including this point.

Returns

The end.

Here is the caller graph for this function:

int broad.core.datastructures.Interval.getLength

(

)

End - start.

int broad.core.datastructures.Interval.getRelationship

(

Interval

interval

)

Returns a constant that describes the relationship of this interval to a specified interval with regard to position on the number line.

Parameters

interval

The interval to compare this one to.

Returns

One of the IS_* constants defined above.

int broad.core.datastructures.Interval.getStart

(

)

Returns the starting point of the interval.

Returns

The start.

Here is the caller graph for this function:

boolean broad.core.datastructures.Interval.isAdjacent

(

Interval

interval

)

Returns true if this interval ends where the specified interval starts, or vice versa.

Parameters

interval

The interval to compare this one to.

Returns

True, if adjacent.

Member Data Documentation

final int broad.core.datastructures.Interval.HAS_GREATER_PART = 4

static

final int broad.core.datastructures.Interval.HAS_LESSER_PART = 1

static

final int broad.core.datastructures.Interval.HAS_OVERLAPPING_PART = 2

static

final int broad.core.datastructures.Interval.IS_ADJACENT_AND_EMPTY = 0

static

final int broad.core.datastructures.Interval.IS_LEFT_OVERHANGING_OVERLAPPER = HAS_LESSER_PART | HAS_OVERLAPPING_PART

static

final int broad.core.datastructures.Interval.IS_RIGHT_OVERHANGING_OVERLAPPER = HAS_GREATER_PART | HAS_OVERLAPPING_PART

static

final int broad.core.datastructures.Interval.IS_STRICTLY_GREATER = HAS_GREATER_PART

static

final int broad.core.datastructures.Interval.IS_STRICTLY_LESS = HAS_LESSER_PART

static

final int broad.core.datastructures.Interval.IS_SUBSET = HAS_OVERLAPPING_PART

static

final int broad.core.datastructures.Interval.IS_SUPERSET = HAS_LESSER_PART | HAS_OVERLAPPING_PART | HAS_GREATER_PART

static

---

The documentation for this interface was generated from the following file:

• java/broad/core/datastructures/Interval.java