net.kreatious.pianoleopard.intervalset

Class IntervalSet<V>

java.lang.Object

net.kreatious.pianoleopard.intervalset.IntervalSet<V>

Type Parameters:

V - the type of mapped values

All Implemented Interfaces:

Iterable<V>

public class IntervalSet<V>
extends Object
implements Iterable<V>

An ordered tree data structure for holding intervals. The user can efficiently find all intervals that overlap with a given interval or point.

Interval sets are optimized for being queried far more often than they are modified.

This set does not support null keys or values, but does support duplicate intervals.

Author:

Jay-R Studer

Constructor Summary

Constructors

Constructor and Description
IntervalSet()

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all values from this set.
Iterator<V>	iterator()
Optional<V>	put(long low, long high, V value) Associates the specified interval with the specified value in this set.
Optional<V>	removeFirst(long low, long high, Predicate<? super V> criteria) Removes the first value for the specified interval from this set that matches the given criteria.
int	size() Returns the size of this set.
Iterable<V>	subSet(long low, long high) Returns an iterable read only view of the values in this set that overlaps the specified interval.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

IntervalSet

public IntervalSet()

Method Detail

clear

public void clear()

Removes all values from this set.

size

public int size()

Returns the size of this set.

Returns:

the number of values in this collection

put

public Optional<V> put(long low,
                       long high,
                       V value)

Associates the specified interval with the specified value in this set. If this set previously contained a mapping for the interval, the old value is replaced. If the specified interval is invalid, nothing is inserted.

Parameters:

low - the low end of the range the specified value to associate

high - the high end of the range the specified value to associate

value - value to be associated with the specified key

Returns:

the previous value associated with the interval, or empty if there was no mapping for the interval.

Throws:

NullPointerException - if the specified key or value is null

removeFirst

public Optional<V> removeFirst(long low,
                               long high,
                               Predicate<? super V> criteria)

Removes the first value for the specified interval from this set that matches the given criteria.

Parameters:

low - the low end of the range the specified value to associate

high - the high end of the range the specified value to associate

criteria - the value to delete

Returns:

the removed value, or empty if no value was removed

Throws:

IllegalArgumentException - if low is greater than high

NullPointerException - if the specified key is null

subSet

public Iterable<V> subSet(long low,
                          long high)

Returns an iterable read only view of the values in this set that overlaps the specified interval. If low and high are equal, the returned view contains the intervals containing a single point.

Parameters:

low - low portion of the interval to retrieve

high - high portion of the interval to retrieve

Returns:

a read only view of the portion of this set overlapping the specified interval.

Throws:

IllegalArgumentException - if low is greater than high

iterator

public Iterator<V> iterator()

Specified by:

iterator in interface Iterable<V>