org.apache.druid.extendedset.intset

Class ConciseSet

java.lang.Object

org.apache.druid.extendedset.intset.AbstractIntSet

org.apache.druid.extendedset.intset.ConciseSet

All Implemented Interfaces:

Serializable, Cloneable, Comparable<IntSet>, IntSet

public class ConciseSet
extends AbstractIntSet
implements Serializable

This is CONCISE: COmpressed 'N' Composable Integer SEt.

This class is an instance of IntSet internally represented by compressed bitmaps though a RLE (Run-Length Encoding) compression algorithm. See http://ricerca.mat.uniroma3.it/users/dipietro/publications/0020-0190.pdf for more details.

Notice that the iterator by iterator() is fail-fast, similar to most Collection-derived classes. If the set is structurally modified at any time after the iterator is created, the iterator will throw a ConcurrentModificationException. Thus, in the face of concurrent modification, the iterator fails quickly and cleanly, rather than risking arbitrary, non-deterministic behavior at an undetermined time in the future. The iterator throws a ConcurrentModificationException on a best-effort basis. Therefore, it would be wrong to write a program that depended on this exception for its correctness: the fail-fast behavior of iterators should be used only to detect bugs.

Version:

$Id$

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.druid.extendedset.intset.IntSet

IntSet.IntIterator

Constructor Summary

Constructors

Constructor and Description
ConciseSet() Creates an empty integer set
ConciseSet(boolean simulateWAH) Creates an empty integer set
ConciseSet(int[] words, boolean simulateWAH)

Method Summary

Modifier and Type	Method and Description
boolean	add(int e)
boolean	addAll(IntSet c)
void	clear()
ConciseSet	clone() See the clone() of Object
int	compareTo(IntSet o)
boolean	contains(int o)
ConciseSet	convert(int... a)
IntSet.IntIterator	descendingIterator()
ConciseSet	empty()
boolean	equals(Object obj)
int[]	getWords()
int	hashCode()
ConciseSet	intersection(IntSet other)
boolean	isEmpty()
IntSet.IntIterator	iterator()
boolean	remove(int o)
int	size()

Methods inherited from class org.apache.druid.extendedset.intset.AbstractIntSet

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ConciseSet

public ConciseSet()

Creates an empty integer set

ConciseSet

public ConciseSet(boolean simulateWAH)

Creates an empty integer set

Parameters:

simulateWAH - true if the class must simulate the behavior of WAH

ConciseSet

public ConciseSet(int[] words,
                  boolean simulateWAH)

Method Detail

clone

public ConciseSet clone()

See the clone() of Object

Specified by:

clone in interface IntSet

Specified by:

clone in class AbstractIntSet

Returns:

cloned object

getWords

public int[] getWords()

intersection

public ConciseSet intersection(IntSet other)

iterator

public IntSet.IntIterator iterator()

Specified by:

iterator in interface IntSet

Specified by:

iterator in class AbstractIntSet

Returns:

a IntSet.IntIterator instance to iterate over the set

descendingIterator

public IntSet.IntIterator descendingIterator()

Specified by:

descendingIterator in interface IntSet

Specified by:

descendingIterator in class AbstractIntSet

Returns:

a IntSet.IntIterator instance to iterate over the set in descending order

clear

public void clear()

convert

public ConciseSet convert(int... a)

add

public boolean add(int e)

remove

public boolean remove(int o)

contains

public boolean contains(int o)

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IntSet

Specified by:

isEmpty in class AbstractIntSet

Returns:

true if this set contains no elements

addAll

public boolean addAll(IntSet c)

size

public int size()

Specified by:

size in interface IntSet

Specified by:

size in class AbstractIntSet

Returns:

the number of elements in this set (its cardinality)

empty

public ConciseSet empty()

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractIntSet

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractIntSet

compareTo

public int compareTo(IntSet o)

Specified by:

compareTo in interface Comparable<IntSet>

Overrides:

compareTo in class AbstractIntSet