Package net.solarnetwork.util

Class IntRangeSet

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<Integer>

net.solarnetwork.util.IntRangeSet

All Implemented Interfaces:

Cloneable, Iterable<Integer>, Collection<Integer>, NavigableSet<Integer>, Set<Integer>, SortedSet<Integer>, IntOrderedIterable

public class IntRangeSet
extends AbstractSet<Integer>
implements NavigableSet<Integer>, IntOrderedIterable, Cloneable

A Set implementation based on ordered and disjoint integer ranges.

This set is optimized for integer sets where ranges of consecutive integers are common. Instead of storing individual integer values, it stores an ordered list of IntRange objects whose ranges do not overlap. The ranges() method can be used to get the list of ranges.

Since:

1.58

Version:

1.0

Author:

matt

Constructor Summary

Constructors

Constructor	Description
IntRangeSet()	Default constructor.
IntRangeSet(int initialCapacity)	Construct with an initial capacity.
IntRangeSet(Collection<Integer> c)	Construct from an existing set of values.
IntRangeSet(IntRange... ranges)	Construct from an existing set of ranges.

Method Summary

Modifier and Type	Method	Description
boolean	add(int v)	Add a single integer to this set.
boolean	add(Integer e)	Add an integer to this set.
boolean	addAll(Collection<? extends Integer> col)
boolean	addRange(int min, int max)	Add a range of integers, inclusive.
boolean	addRange(IntRange range)	Add a range of integers, inclusive.
Integer	ceiling(Integer e)
void	clear()
Object	clone()
Comparator<? super Integer>	comparator()
Iterator<Integer>	descendingIterator()
NavigableSet<Integer>	descendingSet()
Integer	first()
Integer	floor(Integer e)
void	forEachOrdered(int min, int max, IntConsumer action)	Iterate over a range of values in this collection.
void	forEachOrdered(IntConsumer action)	Iterate over all primitive values in this collection.
SortedSet<Integer>	headSet(Integer toElement)
NavigableSet<Integer>	headSet(Integer toElement, boolean inclusive)
Integer	higher(Integer e)
IntRangeSet	immutableCopy()	Get an immutable copy of this set.
boolean	isEmpty()
Iterator<Integer>	iterator()
Integer	last()
Integer	lower(Integer e)
Integer	pollFirst()
Integer	pollLast()
Iterable<IntRange>	ranges()	Get the ranges of this set.
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
int	size()
NavigableSet<Integer>	subSet(Integer fromElement, boolean fromInclusive, Integer toElement, boolean toInclusive)
SortedSet<Integer>	subSet(Integer fromElement, Integer toElement)
SortedSet<Integer>	tailSet(Integer fromElement)
NavigableSet<Integer>	tailSet(Integer fromElement, boolean inclusive)
String	toString()

Methods inherited from class java.util.AbstractSet

equals, hashCode

Methods inherited from class java.util.AbstractCollection

contains, containsAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

contains, containsAll, equals, hashCode, retainAll, toArray, toArray

Methods inherited from interface java.util.SortedSet

spliterator

Constructor Details

IntRangeSet

public IntRangeSet()

Default constructor.

IntRangeSet

public IntRangeSet(int initialCapacity)

Construct with an initial capacity.

Parameters:

initialCapacity - the initial capacity, which refers to the number of discreet ranges, not elements

IntRangeSet

public IntRangeSet(Collection<Integer> c)

Construct from an existing set of values.

Parameters:

c - the integer collection to copy into this set

IntRangeSet

public IntRangeSet(IntRange... ranges)

Construct from an existing set of ranges.

Parameters:

ranges - the ranges to copy into this set

Method Details

immutableCopy

public IntRangeSet immutableCopy()

Get an immutable copy of this set.

Returns:

an immutable copy of this set

clone

public Object clone()

Overrides:

clone in class Object

toString

public String toString()

Overrides:

toString in class AbstractCollection<Integer>

forEachOrdered

public void forEachOrdered(IntConsumer action)

Description copied from interface: IntOrderedIterable

Iterate over all primitive values in this collection.

This method of iteration can be more efficient than iterating via the Iterator API because no unboxing of primitives is necessary.

Specified by:

forEachOrdered in interface IntOrderedIterable

Parameters:

action - the consumer to handle the values

forEachOrdered

public void forEachOrdered(int min,
 int max,
 IntConsumer action)

Description copied from interface: IntOrderedIterable

Iterate over a range of values in this collection.

This method of iteration can be more efficient than iterating via the Iterator API because no unboxing of primitives is necessary.

Specified by:

forEachOrdered in interface IntOrderedIterable

Parameters:

min - the minimum key value (inclusive)

max - the maximum key value (exclusive)

action - the consumer to handle the values

add

public boolean add(Integer e)

Add an integer to this set.

Specified by:

add in interface Collection<Integer>

Specified by:

add in interface Set<Integer>

Overrides:

add in class AbstractCollection<Integer>

See Also:

• add(int)

add

public boolean add(int v)

Add a single integer to this set.

This method requires a linear search of all existing discreet ranges to maintain ordering and possibly merge the value into an existing range or cause two ranges to merge together.

Parameters:

v - the integer to add

Returns:

true if this set changed as a result

addAll

public boolean addAll(Collection<? extends Integer> col)

Specified by:

addAll in interface Collection<Integer>

Specified by:

addAll in interface Set<Integer>

Overrides:

addAll in class AbstractCollection<Integer>

addRange

public boolean addRange(int min,
 int max)

Add a range of integers, inclusive.

Parameters:

min - the starting value to add

max - the last value to add

Returns:

true if any changes resulted from adding the given range

See Also:

• addRange(IntRange)

addRange

public boolean addRange(IntRange range)

Add a range of integers, inclusive.

This method requires a linear search of all existing discreet ranges to maintain ordering and possibly merge the given range into an existing range or cause existing ranges to merge together.

Parameters:

range - the range to add

Returns:

true if any changes resulted from adding the given range

clear

public void clear()

Specified by:

clear in interface Collection<Integer>

Specified by:

clear in interface Set<Integer>

Overrides:

clear in class AbstractCollection<Integer>

iterator

public Iterator<Integer> iterator()

Specified by:

iterator in interface Collection<Integer>

Specified by:

iterator in interface Iterable<Integer>

Specified by:

iterator in interface NavigableSet<Integer>

Specified by:

iterator in interface Set<Integer>

Specified by:

iterator in class AbstractCollection<Integer>

ranges

public Iterable<IntRange> ranges()

Get the ranges of this set.

This returns a "live" reference to the ranges in this set; mutations to this set will impact the values in the returned collection.

Returns:

the disjoint ranges in this set, ordered from least to greatest, never null

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<Integer>

Specified by:

isEmpty in interface Set<Integer>

Overrides:

isEmpty in class AbstractCollection<Integer>

size

public int size()

Specified by:

size in interface Collection<Integer>

Specified by:

size in interface Set<Integer>

Specified by:

size in class AbstractCollection<Integer>

comparator

public Comparator<? super Integer> comparator()

Specified by:

comparator in interface SortedSet<Integer>

first

public Integer first()

Specified by:

first in interface SortedSet<Integer>

last

public Integer last()

Specified by:

last in interface SortedSet<Integer>

lower

public Integer lower(Integer e)

Specified by:

lower in interface NavigableSet<Integer>

floor

public Integer floor(Integer e)

Specified by:

floor in interface NavigableSet<Integer>

ceiling

public Integer ceiling(Integer e)

Specified by:

ceiling in interface NavigableSet<Integer>

higher

public Integer higher(Integer e)

Specified by:

higher in interface NavigableSet<Integer>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<Integer>

Specified by:

remove in interface Set<Integer>

Overrides:

remove in class AbstractCollection<Integer>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<Integer>

Specified by:

removeAll in interface Set<Integer>

Overrides:

removeAll in class AbstractSet<Integer>

pollFirst

public Integer pollFirst()

Specified by:

pollFirst in interface NavigableSet<Integer>

pollLast

public Integer pollLast()

Specified by:

pollLast in interface NavigableSet<Integer>

descendingSet

public NavigableSet<Integer> descendingSet()

Specified by:

descendingSet in interface NavigableSet<Integer>

descendingIterator

public Iterator<Integer> descendingIterator()

Specified by:

descendingIterator in interface NavigableSet<Integer>

subSet

public SortedSet<Integer> subSet(Integer fromElement,
 Integer toElement)

Specified by:

subSet in interface NavigableSet<Integer>

Specified by:

subSet in interface SortedSet<Integer>

subSet

public NavigableSet<Integer> subSet(Integer fromElement,
 boolean fromInclusive,
 Integer toElement,
 boolean toInclusive)

Specified by:

subSet in interface NavigableSet<Integer>

headSet

public NavigableSet<Integer> headSet(Integer toElement,
 boolean inclusive)

Specified by:

headSet in interface NavigableSet<Integer>

tailSet

public NavigableSet<Integer> tailSet(Integer fromElement,
 boolean inclusive)

Specified by:

tailSet in interface NavigableSet<Integer>

headSet

public SortedSet<Integer> headSet(Integer toElement)

Specified by:

headSet in interface NavigableSet<Integer>

Specified by:

headSet in interface SortedSet<Integer>

tailSet

public SortedSet<Integer> tailSet(Integer fromElement)

Specified by:

tailSet in interface NavigableSet<Integer>

Specified by:

tailSet in interface SortedSet<Integer>