fr.cnes.sirius.patrius.math.interval

Class ComparableIntervalsList<T extends Comparable<T>>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

java.util.TreeSet<ComparableInterval<T>>

fr.cnes.sirius.patrius.math.interval.ComparableIntervalsList<T>

Type Parameters:

T - the nature of ending points

All Implemented Interfaces:

Serializable, Cloneable, Iterable<ComparableInterval<T>>, Collection<ComparableInterval<T>>, NavigableSet<ComparableInterval<T>>, Set<ComparableInterval<T>>, SortedSet<ComparableInterval<T>>

public class ComparableIntervalsList<T extends Comparable<T>>
extends TreeSet<ComparableInterval<T>>

This class represents a list of objects ComparableInterval.

It extends a TreeSet of ComparableInterval instances. Since the objects of the list implement the ComparableInterval class, the list is an ordered collection.

The generic class must implement java.lang.Comparable
It is HIGHLY recommended this class be immutable!

Author:

GMV

See Also:

ComparableInterval, TreeSet, Serialized Form

Concurrency :

not thread-safe (TreeSet is not thread-safe)

Constructor Summary

Constructors

Constructor and Description
ComparableIntervalsList()

Method Summary

Modifier and Type	Method and Description
ComparableInterval<T>	getInclusiveInterval() Returns the shortest interval that contains all the intervals of the list.
ComparableIntervalsList<T>	getIntersectionWith(ComparableInterval<T> interval) Returns the intersection between an interval and all the intervals of the list.
ComparableIntervalsList<T>	getIntervalsContaining(T entry) Returns the intervals of the list that contain the provided entry.
ComparableIntervalsList<T>	getMergedIntervals() Merges the intervals of the list that overlap and returns the list of merged intervals.
boolean	includes(ComparableInterval<T> interval) Returns true if the provided interval is included in one of the intervals of the list.
boolean	overlaps(ComparableInterval<T> interval) Returns true if the provided interval overlaps one of the intervals of the list.

Methods inherited from class java.util.TreeSet

add, addAll, ceiling, clear, clone, comparator, contains, descendingIterator, descendingSet, first, floor, headSet, headSet, higher, isEmpty, iterator, last, lower, pollFirst, pollLast, remove, size, spliterator, subSet, subSet, tailSet, tailSet

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

containsAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Set

containsAll, equals, hashCode, removeAll, retainAll, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

ComparableIntervalsList

public ComparableIntervalsList()

Method Detail

overlaps

public boolean overlaps(ComparableInterval<T> interval)

Returns true if the provided interval overlaps one of the intervals of the list.

Parameters:

interval - the interval

Returns:

true if the interval overlaps one of the interval of the list

includes

public boolean includes(ComparableInterval<T> interval)

Returns true if the provided interval is included in one of the intervals of the list.

Parameters:

interval - the interval

Returns:

true if the interval is included in one of the intervals of the list

getIntervalsContaining

public ComparableIntervalsList<T> getIntervalsContaining(T entry)

Returns the intervals of the list that contain the provided entry.

The list returned can be empty if the entry is not contained in any interval.

Parameters:

entry - the entry

Returns:

the intervals of the list that contain the entry

getInclusiveInterval

public ComparableInterval<T> getInclusiveInterval()

Returns the shortest interval that contains all the intervals of the list.

While an entry included in at least one of the listed intervals must be contained in this global interval, the opposite is not guaranteed (the inclusive interval can contain entries that do not belong to any listed interval).

Returns:

the shortest interval that contains all the intervals of the list

getMergedIntervals

public ComparableIntervalsList<T> getMergedIntervals()

Merges the intervals of the list that overlap and returns the list of merged intervals.

The list returned should not contain any overlapping intervals.

Returns:

the list of merged intervals

getIntersectionWith

public ComparableIntervalsList<T> getIntersectionWith(ComparableInterval<T> interval)

Returns the intersection between an interval and all the intervals of the list.

The list returned can be empty if the provided interval does not intersects any interval of the list.

Parameters:

interval - the interval

Returns:

the intersection between the interval and the list of intervals