it.uniroma3.mat.extendedset.wrappers

Class GenericExtendedSet<T extends Comparable<T>>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<T>

it.uniroma3.mat.extendedset.AbstractExtendedSet<T>

it.uniroma3.mat.extendedset.wrappers.GenericExtendedSet<T>

Type Parameters:

T - the type of elements maintained by this set

All Implemented Interfaces:

ExtendedSet<T>, Cloneable, Comparable<ExtendedSet<T>>, Iterable<T>, Collection<T>, Set<T>, SortedSet<T>

public class GenericExtendedSet<T extends Comparable<T>>
extends AbstractExtendedSet<T>

ExtendedSet-based class internally managed by an instance of any class implementing Collection

Version:

$Id$

Author:

Alessandro Colantonio

Nested Class Summary

Nested classes/interfaces inherited from class it.uniroma3.mat.extendedset.AbstractExtendedSet

AbstractExtendedSet.ExtendedSubSet, AbstractExtendedSet.FilteredSet, AbstractExtendedSet.UnmodifiableExtendedSet

Nested classes/interfaces inherited from interface it.uniroma3.mat.extendedset.ExtendedSet

ExtendedSet.ExtendedIterator<X>

Constructor Summary

Constructors

Constructor and Description
GenericExtendedSet(Class<? extends Collection> setClass) Empty-set constructor

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(T e)
boolean	addAll(Collection<? extends T> c)
double	bitmapCompressionRatio() Computes the compression factor of the equivalent bitmap representation (1 means not compressed, namely a memory footprint similar to BitSet, 2 means twice the size of BitSet, etc.)
void	clear()
GenericExtendedSet<T>	clone() See the clone() of Object
double	collectionCompressionRatio() Computes the compression factor of the equivalent integer collection (1 means not compressed, namely a memory footprint similar to ArrayList, 2 means twice the size of ArrayList, etc.)
Comparator<? super T>	comparator()
void	complement() Complements the current set.
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
GenericExtendedSet<T>	convert(Collection<?> c) Converts a given Collection instance into an instance of the current class.
GenericExtendedSet<T>	convert(Object... e) Converts a given integer array into an instance of the current class
String	debugInfo() Prints debug info about the given ExtendedSet implementation
ExtendedSet.ExtendedIterator<T>	descendingIterator() Gets the descending order iterator over the elements of type T
GenericExtendedSet<T>	difference(Collection<? extends T> other) Generates the difference set
GenericExtendedSet<T>	empty() Generates an empty set
boolean	equals(Object o)
void	fill(T from, T to) Adds to the set all the elements between first and last, both included.
T	first()
int	hashCode()
ExtendedSet<T>	headSet(T toElement)
GenericExtendedSet<T>	intersection(Collection<? extends T> other) Generates the intersection set
int	intersectionSize(Collection<? extends T> other) Computes the intersection set size.
boolean	isEmpty()
ExtendedSet.ExtendedIterator<T>	iterator()
T	last()
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
int	size()
ExtendedSet<T>	subSet(T fromElement, T toElement)
GenericExtendedSet<T>	symmetricDifference(Collection<? extends T> other) Generates the symmetric difference set
ExtendedSet<T>	tailSet(T fromElement)
GenericExtendedSet<T>	union(Collection<? extends T> other) Generates the union set
ExtendedSet<T>	unmodifiable() Gets the read-only version of the current set

Methods inherited from class it.uniroma3.mat.extendedset.AbstractExtendedSet

clear, compareTo, complemented, complementSize, containsAny, containsAtLeast, descending, differenceSize, flip, get, indexOf, jaccardDistance, jaccardSimilarity, powerSet, powerSet, powerSetSize, powerSetSize, symmetricDifferenceSize, unionSize, weightedJaccardDistance, weightedJaccardSimilarity

Methods inherited from class java.util.AbstractCollection

toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Set

toArray, toArray

Constructor Detail

GenericExtendedSet

public GenericExtendedSet(Class<? extends Collection> setClass)

Empty-set constructor

Parameters:

setClass - Collection-derived class

Method Detail

bitmapCompressionRatio

public double bitmapCompressionRatio()

Computes the compression factor of the equivalent bitmap representation (1 means not compressed, namely a memory footprint similar to BitSet, 2 means twice the size of BitSet, etc.)

Specified by:

bitmapCompressionRatio in interface ExtendedSet<T extends Comparable<T>>

Specified by:

bitmapCompressionRatio in class AbstractExtendedSet<T extends Comparable<T>>

Returns:

the compression factor

collectionCompressionRatio

public double collectionCompressionRatio()

Computes the compression factor of the equivalent integer collection (1 means not compressed, namely a memory footprint similar to ArrayList, 2 means twice the size of ArrayList, etc.)

Specified by:

collectionCompressionRatio in interface ExtendedSet<T extends Comparable<T>>

Specified by:

collectionCompressionRatio in class AbstractExtendedSet<T extends Comparable<T>>

Returns:

the compression factor

empty

public GenericExtendedSet<T> empty()

Generates an empty set

Specified by:

empty in interface ExtendedSet<T extends Comparable<T>>

Specified by:

empty in class AbstractExtendedSet<T extends Comparable<T>>

Returns:

the empty set

iterator

public ExtendedSet.ExtendedIterator<T> iterator()

Specified by:

iterator in interface ExtendedSet<T extends Comparable<T>>

Specified by:

iterator in interface Iterable<T extends Comparable<T>>

Specified by:

iterator in interface Collection<T extends Comparable<T>>

Specified by:

iterator in interface Set<T extends Comparable<T>>

Specified by:

iterator in class AbstractExtendedSet<T extends Comparable<T>>

descendingIterator

public ExtendedSet.ExtendedIterator<T> descendingIterator()

Gets the descending order iterator over the elements of type T

Specified by:

descendingIterator in interface ExtendedSet<T extends Comparable<T>>

Overrides:

descendingIterator in class AbstractExtendedSet<T extends Comparable<T>>

Returns:

descending iterator

clone

public GenericExtendedSet<T> clone()

See the clone() of Object

NOTE: When overriding this method, please note that Object.clone() is much slower then performing new and "manually" copying data!

Specified by:

clone in interface ExtendedSet<T extends Comparable<T>>

Overrides:

clone in class AbstractExtendedSet<T extends Comparable<T>>

Returns:

cloned object

debugInfo

public String debugInfo()

Prints debug info about the given ExtendedSet implementation

Specified by:

debugInfo in interface ExtendedSet<T extends Comparable<T>>

Overrides:

debugInfo in class AbstractExtendedSet<T extends Comparable<T>>

Returns:

a string that describes the internal representation of the instance

add

public boolean add(T e)

Specified by:

add in interface Collection<T extends Comparable<T>>

Specified by:

add in interface Set<T extends Comparable<T>>

Overrides:

add in class AbstractCollection<T extends Comparable<T>>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<T extends Comparable<T>>

Specified by:

remove in interface Set<T extends Comparable<T>>

Overrides:

remove in class AbstractCollection<T extends Comparable<T>>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<T extends Comparable<T>>

Specified by:

contains in interface Set<T extends Comparable<T>>

Overrides:

contains in class AbstractCollection<T extends Comparable<T>>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<T extends Comparable<T>>

Specified by:

containsAll in interface Set<T extends Comparable<T>>

Overrides:

containsAll in class AbstractCollection<T extends Comparable<T>>

addAll

public boolean addAll(Collection<? extends T> c)

Specified by:

addAll in interface Collection<T extends Comparable<T>>

Specified by:

addAll in interface Set<T extends Comparable<T>>

Overrides:

addAll in class AbstractCollection<T extends Comparable<T>>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<T extends Comparable<T>>

Specified by:

retainAll in interface Set<T extends Comparable<T>>

Overrides:

retainAll in class AbstractCollection<T extends Comparable<T>>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<T extends Comparable<T>>

Specified by:

removeAll in interface Set<T extends Comparable<T>>

Overrides:

removeAll in class AbstractSet<T extends Comparable<T>>

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<T extends Comparable<T>>

Specified by:

equals in interface Set<T extends Comparable<T>>

Overrides:

equals in class AbstractSet<T extends Comparable<T>>

size

public int size()

Specified by:

size in interface Collection<T extends Comparable<T>>

Specified by:

size in interface Set<T extends Comparable<T>>

Specified by:

size in class AbstractCollection<T extends Comparable<T>>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<T extends Comparable<T>>

Specified by:

isEmpty in interface Set<T extends Comparable<T>>

Overrides:

isEmpty in class AbstractCollection<T extends Comparable<T>>

clear

public void clear()

Specified by:

clear in interface Collection<T extends Comparable<T>>

Specified by:

clear in interface Set<T extends Comparable<T>>

Overrides:

clear in class AbstractCollection<T extends Comparable<T>>

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<T extends Comparable<T>>

Specified by:

hashCode in interface Set<T extends Comparable<T>>

Overrides:

hashCode in class AbstractSet<T extends Comparable<T>>

comparator

public Comparator<? super T> comparator()

first

public T first()

Specified by:

first in interface SortedSet<T extends Comparable<T>>

Overrides:

first in class AbstractExtendedSet<T extends Comparable<T>>

last

public T last()

Specified by:

last in interface SortedSet<T extends Comparable<T>>

Overrides:

last in class AbstractExtendedSet<T extends Comparable<T>>

headSet

public ExtendedSet<T> headSet(T toElement)

Specified by:

headSet in interface ExtendedSet<T extends Comparable<T>>

Specified by:

headSet in interface SortedSet<T extends Comparable<T>>

Overrides:

headSet in class AbstractExtendedSet<T extends Comparable<T>>

tailSet

public ExtendedSet<T> tailSet(T fromElement)

Specified by:

tailSet in interface ExtendedSet<T extends Comparable<T>>

Specified by:

tailSet in interface SortedSet<T extends Comparable<T>>

Overrides:

tailSet in class AbstractExtendedSet<T extends Comparable<T>>

subSet

public ExtendedSet<T> subSet(T fromElement,
                    T toElement)

Specified by:

subSet in interface ExtendedSet<T extends Comparable<T>>

Specified by:

subSet in interface SortedSet<T extends Comparable<T>>

Overrides:

subSet in class AbstractExtendedSet<T extends Comparable<T>>

intersectionSize

public int intersectionSize(Collection<? extends T> other)

Computes the intersection set size.

This is faster than calling ExtendedSet.intersection(Collection) and then Set.size()

Specified by:

intersectionSize in interface ExtendedSet<T extends Comparable<T>>

Overrides:

intersectionSize in class AbstractExtendedSet<T extends Comparable<T>>

Parameters:

other - Collection instance that represents the right operand

Returns:

the size

intersection

public GenericExtendedSet<T> intersection(Collection<? extends T> other)

Generates the intersection set

Specified by:

intersection in interface ExtendedSet<T extends Comparable<T>>

Overrides:

intersection in class AbstractExtendedSet<T extends Comparable<T>>

Parameters:

other - ExtendedSet instance that represents the right operand

Returns:

the result of the operation

See Also:

Set.retainAll(java.util.Collection)

union

public GenericExtendedSet<T> union(Collection<? extends T> other)

Generates the union set

Specified by:

union in interface ExtendedSet<T extends Comparable<T>>

Overrides:

union in class AbstractExtendedSet<T extends Comparable<T>>

Parameters:

other - ExtendedSet instance that represents the right operand

Returns:

the result of the operation

See Also:

Set.addAll(java.util.Collection)

difference

public GenericExtendedSet<T> difference(Collection<? extends T> other)

Generates the difference set

Specified by:

difference in interface ExtendedSet<T extends Comparable<T>>

Overrides:

difference in class AbstractExtendedSet<T extends Comparable<T>>

Parameters:

other - ExtendedSet instance that represents the right operand

Returns:

the result of the operation

See Also:

Set.removeAll(java.util.Collection)

symmetricDifference

public GenericExtendedSet<T> symmetricDifference(Collection<? extends T> other)

Generates the symmetric difference set

Specified by:

symmetricDifference in interface ExtendedSet<T extends Comparable<T>>

Overrides:

symmetricDifference in class AbstractExtendedSet<T extends Comparable<T>>

Parameters:

other - ExtendedSet instance that represents the right operand

Returns:

the result of the operation

See Also:

ExtendedSet.flip(Object)

complement

public void complement()

Complements the current set. The modified set is represented by all the elements strictly less than SortedSet.last() that do not exist in the current set.

See Also:

ExtendedSet.complemented()

unmodifiable

public ExtendedSet<T> unmodifiable()

Gets the read-only version of the current set

Specified by:

unmodifiable in interface ExtendedSet<T extends Comparable<T>>

Overrides:

unmodifiable in class AbstractExtendedSet<T extends Comparable<T>>

Returns:

the read-only version of the current set

fill

public void fill(T from,
        T to)

Adds to the set all the elements between first and last, both included. It supposes that there is an ordering of the elements of type T and that the universe of all possible elements is known.

Specified by:

fill in interface ExtendedSet<T extends Comparable<T>>

Overrides:

fill in class AbstractExtendedSet<T extends Comparable<T>>

Parameters:

from - first element

to - last element

convert

public GenericExtendedSet<T> convert(Collection<?> c)

Converts a given Collection instance into an instance of the current class. NOTE: when the collection is already an instance of the current class, the method returns the collection itself.

Specified by:

convert in interface ExtendedSet<T extends Comparable<T>>

Overrides:

convert in class AbstractExtendedSet<T extends Comparable<T>>

Parameters:

c - collection to use to generate the new instance

Returns:

the converted collection

See Also:

ExtendedSet.convert(Object...)

convert

public GenericExtendedSet<T> convert(Object... e)

Converts a given integer array into an instance of the current class

Specified by:

convert in interface ExtendedSet<T extends Comparable<T>>

Overrides:

convert in class AbstractExtendedSet<T extends Comparable<T>>

Parameters:

e - objects to use to generate the new instance

Returns:

the converted collection

See Also:

ExtendedSet.convert(Collection)