Package com.amalgamasimulation.core.scheduling

Class Gap<T extends Slot>

java.lang.Object

com.amalgamasimulation.core.intervals.Interval

com.amalgamasimulation.core.scheduling.TimeInterval

com.amalgamasimulation.core.scheduling.Gap<T>

Type Parameters:

T - type of slots

All Implemented Interfaces:

IntervalLike, Comparable<IntervalLike>

public class Gap<T extends Slot>
extends TimeInterval

Class representing a (possibly infinite) gap between at most two slots in a Sequence. A gap can be bounded by prevSlot() in the beginning and by nextSlot() in the end. Like any other TimeInterval, a gap has TimeInterval.beginTime(), TimeInterval.endTime() and TimeInterval.duration(). Both begin time and end time can be infinite. Gaps of negative duration are not allowed.

Author:

Andrey Malykhanov

See Also:

• Slot
• TimeInterval

Field Summary

Fields inherited from class com.amalgamasimulation.core.intervals.Interval

EMPTY, max, min, UNIVERSE

Constructor Summary

Constructors

Constructor	Description
Gap(Sequence<T> sequence, double beginTime, double endTime, T prevSlot, T nextSlot)	Creates a new gap with the specified begin time, end time, begin slot and end slot.

Method Summary

Modifier and Type	Method	Description
static Gap<?>	dummy(double time)	Creates a dummy instance of Gap used primarily as a key in search and comparison methods.
Gap<T>	getIntersection(Gap<?> gap)	Returns the gap that is the result of intersecting this gap with the specified other gap, or null if this gap does not intersect with the specified other gap.
Gap<T>	getIntersection(Slot slot)	Returns the gap that is the result of intersecting this gap with the specified slot, or null if this gap does not intersect with the specified slot.
T	nextSlot()	Returns the slot limiting this gap from the right.
T	prevSlot()	Returns the slot limiting this gap from the left.
Sequence<T>	sequence()	Returns the Sequence to which this gap belongs.
String	toString()

Methods inherited from class com.amalgamasimulation.core.scheduling.TimeInterval

beginTime, contains, duration, endTime, getExclusion, getIntersection, intersectsWith

Methods inherited from class com.amalgamasimulation.core.intervals.Interval

asIntervalSet, contains, equals, equalsWithinEpsilon, equalsWithinEpsilon, exclusion, hashCode, hasNonZeroIntersectionWith, intersection, isEmpty, isUniverse, leftSubset, max, min, of, of, rightSubset, shift, size, toCodeString, union

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amalgamasimulation.core.intervals.IntervalLike

compareTo, complement, contains, isFinite, isZeroLength, length

Constructor Details

Gap

public Gap(Sequence<T> sequence,
 double beginTime,
 double endTime,
 T prevSlot,
 T nextSlot)

Creates a new gap with the specified begin time, end time, begin slot and end slot.

Parameters:

sequence - sequence of slots to which this gap belongs

beginTime - begin time of the gap, possibly a Double.NEGATIVE_INFINITY

endTime - end time of the gap, possibly a Double.POSITIVE_INFINITY

prevSlot - previous slot limiting this gap, possibly null

nextSlot - next slot limiting this gap, possibly null

Method Details

dummy

public static Gap<?> dummy(double time)

Creates a dummy instance of Gap used primarily as a key in search and comparison methods.

Parameters:

time - time used as a search key

Returns:

dummy instance of Gap

sequence

public Sequence<T> sequence()

Returns the Sequence to which this gap belongs.

Returns:

Sequence to which this gap belongs

prevSlot

public T prevSlot()

Returns the slot limiting this gap from the left. Can be null if this gap is not limited from the left by any slot.

Returns:

reference to Slot limiting this gap from the left, or null

nextSlot

public T nextSlot()

Returns the slot limiting this gap from the right. Can be null if this gap is not limited from the right by any slot.

Returns:

reference to Slot limiting this gap from the right, or null

toString

public String toString()

Overrides:

toString in class Interval

getIntersection

public Gap<T> getIntersection(Slot slot)

Returns the gap that is the result of intersecting this gap with the specified slot, or null if this gap does not intersect with the specified slot.

Parameters:

slot - specified slot

Returns:

gap that is the result of intersecting this gap with the specified slot, or null

getIntersection

public Gap<T> getIntersection(Gap<?> gap)

Returns the gap that is the result of intersecting this gap with the specified other gap, or null if this gap does not intersect with the specified other gap.

Parameters:

gap - specified other gap

Returns:

gap that is the result of intersecting this gap with the specified other gap, or null