AbstractExtendedSet (com.metamx:extendedset 1.3.10 API)

java.lang.Object
- java.util.AbstractCollection<E>
- - java.util.AbstractSet<T>
  - - it.uniroma3.mat.extendedset.AbstractExtendedSet<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>

Direct Known Subclasses:

GenericExtendedSet, IndexedSet, IntegerSet, PairSet
```
public abstract class AbstractExtendedSet<T>
extends AbstractSet<T>
implements ExtendedSet<T>
```
This class provides a skeletal implementation of the ExtendedSet interface to minimize the effort required to implement this interface.
The process of implementing a set by extending this class is very similar, for example, to that of implementing a Collection by extending AbstractCollection.

Version:

$Id: AbstractExtendedSet.java 157 2011-11-14 14:25:15Z cocciasik $

Author:

Alessandro Colantonio

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`AbstractExtendedSet.ExtendedSubSet` Used by `AbstractExtendedSet#headSet(T)` , `AbstractExtendedSet#tailSet(T)` and `AbstractExtendedSet#subSet(T,T)` to offer a restricted view of the entire set
`protected class`	`AbstractExtendedSet.FilteredSet` Base class for `AbstractExtendedSet.ExtendedSubSet` and `AbstractExtendedSet.UnmodifiableExtendedSet`
`protected class`	`AbstractExtendedSet.UnmodifiableExtendedSet` Read-only view of the set.

Nested classes/interfaces inherited from interface it.uniroma3.mat.extendedset.ExtendedSet
ExtendedSet.ExtendedIterator<X>

Constructor Summary

Constructors
Constructor and Description

AbstractExtendedSet()

Constructors
Constructor and Description
`AbstractExtendedSet()`

Method Summary

Methods
Modifier and Type	Method and Description
`abstract 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(T from, T to)` Removes from the set all the elements between `first` and `last`, both included.
`ExtendedSet<T>`	`clone()` See the `clone()` of `Object`
`abstract 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.)
`int`	`compareTo(ExtendedSet<T> o)` Compares this object with the specified object for order.
`ExtendedSet<T>`	`complemented()` Generates the complement set.
`int`	`complementSize()` Computes the complement set size.
`boolean`	`containsAny(Collection<? extends T> other)` Returns `true` if the specified `Collection` instance contains any elements that are also contained within this `ExtendedSet` instance
`boolean`	`containsAtLeast(Collection<? extends T> other, int minElements)` Returns `true` if the specified `Collection` instance contains at least `minElements` elements that are also contained within this `ExtendedSet` instance
`ExtendedSet<T>`	`convert(Collection<?> c)` Converts a given `Collection` instance into an instance of the current class.
`ExtendedSet<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
`Iterable<T>`	`descending()` Allows to use the Java "for-each" statement in descending order
`ExtendedSet.ExtendedIterator<T>`	`descendingIterator()` Gets the descending order iterator over the elements of type `T`
`ExtendedSet<T>`	`difference(Collection<? extends T> other)` Generates the difference set
`int`	`differenceSize(Collection<? extends T> other)` Computes the difference set size.
`abstract ExtendedSet<T>`	`empty()` Generates an empty set
`void`	`fill(T from, T to)` Adds to the set all the elements between `first` and `last`, both included.
`T`	`first()`
`void`	`flip(T e)` Adds the element if it not existing, or removes it if existing
`T`	`get(int i)` Gets the `i`^th element of the set
`ExtendedSet<T>`	`headSet(T toElement)`
`int`	`indexOf(T e)` Provides position of element within the set.
`ExtendedSet<T>`	`intersection(Collection<? extends T> other)` Generates the intersection set
`int`	`intersectionSize(Collection<? extends T> other)` Computes the intersection set size.
`abstract ExtendedSet.ExtendedIterator<T>`	`iterator()`
`double`	`jaccardDistance(ExtendedSet<T> other)` Computes the Jaccard distance between this set and the given set.
`double`	`jaccardSimilarity(ExtendedSet<T> other)` Computes the Jaccard similarity coefficient between this set and the given set.
`T`	`last()`
`List<? extends ExtendedSet<T>>`	`powerSet()` Computes the power-set of the current set.
`List<? extends ExtendedSet<T>>`	`powerSet(int min, int max)` Computes a subset of the power-set of the current set, composed by those subsets that have cardinality between `min` and `max`.
`int`	`powerSetSize()` Computes the power-set size of the current set.
`int`	`powerSetSize(int min, int max)` Computes the power-set size of the current set, composed by those subsets that have cardinality between `min` and `max`.
`ExtendedSet<T>`	`subSet(T fromElement, T toElement)`
`ExtendedSet<T>`	`symmetricDifference(Collection<? extends T> other)` Generates the symmetric difference set
`int`	`symmetricDifferenceSize(Collection<? extends T> other)` Computes the symmetric difference set size.
`ExtendedSet<T>`	`tailSet(T fromElement)`
`ExtendedSet<T>`	`union(Collection<? extends T> other)` Generates the union set
`int`	`unionSize(Collection<? extends T> other)` Computes the union set size.
`ExtendedSet<T>`	`unmodifiable()` Gets the read-only version of the current set
`double`	`weightedJaccardDistance(ExtendedSet<T> other)` Computes the weighted version of the Jaccard distance between this set and the given set.
`double`	`weightedJaccardSimilarity(ExtendedSet<T> other)` Computes the weighted version of the Jaccard similarity coefficient between this set and the given set.

Methods inherited from class java.util.AbstractSet
equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection
add, addAll, clear, contains, containsAll, isEmpty, remove, retainAll, size, toArray, toArray, toString

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface it.uniroma3.mat.extendedset.ExtendedSet
complement

Methods inherited from interface java.util.SortedSet
comparator

Methods inherited from interface java.util.Set
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, remove, removeAll, retainAll, size, toArray, toArray

- Constructor Detail
  - AbstractExtendedSet
```
public AbstractExtendedSet()
```
- Method Detail
  - intersection
```
public ExtendedSet<T> intersection(Collection<? extends T> other)
```
    Generates the intersection set
    
    Specified by:
    
    intersection in interface ExtendedSet<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 ExtendedSet<T> union(Collection<? extends T> other)
```
    Generates the union set
    
    Specified by:
    
    union in interface ExtendedSet<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 ExtendedSet<T> difference(Collection<? extends T> other)
```
    Generates the difference set
    
    Specified by:
    
    difference in interface ExtendedSet<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 ExtendedSet<T> symmetricDifference(Collection<? extends T> other)
```
    Generates the symmetric difference set
    
    Specified by:
    
    symmetricDifference in interface ExtendedSet<T>
    
    Parameters:
    other - ExtendedSet instance that represents the right operand
    
    Returns:
    the result of the operation
    See Also:
    ExtendedSet.flip(Object)
  - complemented
```
public ExtendedSet<T> complemented()
```
    Generates the complement set. The returned set is represented by all the elements strictly less than SortedSet.last() that do not exist in the current set.
    
    Specified by:
    
    complemented in interface ExtendedSet<T>
    
    Returns:
    the complement set
    See Also:
    ExtendedSet.complement()
  - containsAny
```
public boolean containsAny(Collection<? extends T> other)
```
    Returns true if the specified Collection instance contains any elements that are also contained within this ExtendedSet instance
    
    Specified by:
    
    containsAny in interface ExtendedSet<T>
    
    Parameters:
    other - ExtendedSet to intersect with
    
    Returns:
    a boolean indicating whether this ExtendedSet intersects the specified ExtendedSet.
  - containsAtLeast
```
public boolean containsAtLeast(Collection<? extends T> other,
                      int minElements)
```
    Returns true if the specified Collection instance contains at least minElements elements that are also contained within this ExtendedSet instance
    
    Specified by:
    
    containsAtLeast in interface ExtendedSet<T>
    
    Parameters:
    other - Collection instance to intersect with
    minElements - minimum number of elements to be contained within this ExtendedSet instance
    
    Returns:
    a boolean indicating whether this ExtendedSet intersects the specified Collection.
  - 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>
    
    Parameters:
    other - Collection instance that represents the right operand
    
    Returns:
    the size
  - unionSize
```
public int unionSize(Collection<? extends T> other)
```
    Computes the union set size.
    This is faster than calling ExtendedSet.union(Collection) and then Set.size()
    
    Specified by:
    
    unionSize in interface ExtendedSet<T>
    
    Parameters:
    other - Collection instance that represents the right operand
    
    Returns:
    the size
  - symmetricDifferenceSize
```
public int symmetricDifferenceSize(Collection<? extends T> other)
```
    Computes the symmetric difference set size.
    This is faster than calling ExtendedSet.symmetricDifference(Collection) and then Set.size()
    
    Specified by:
    
    symmetricDifferenceSize in interface ExtendedSet<T>
    
    Parameters:
    other - Collection instance that represents the right operand
    
    Returns:
    the size
  - differenceSize
```
public int differenceSize(Collection<? extends T> other)
```
    Computes the difference set size.
    This is faster than calling ExtendedSet.difference(Collection) and then Set.size()
    
    Specified by:
    
    differenceSize in interface ExtendedSet<T>
    
    Parameters:
    other - Collection instance that represents the right operand
    
    Returns:
    the size
  - complementSize
```
public int complementSize()
```
    Computes the complement set size.
    This is faster than calling ExtendedSet.complemented() and then Set.size()
    
    Specified by:
    
    complementSize in interface ExtendedSet<T>
    
    Returns:
    the size
  - empty
```
public abstract ExtendedSet<T> empty()
```
    Generates an empty set
    
    Specified by:
    
    empty in interface ExtendedSet<T>
    
    Returns:
    the empty set
  - headSet
```
public ExtendedSet<T> headSet(T toElement)
```
    Specified by:
    
    headSet in interface ExtendedSet<T>
    
    Specified by:
    
    headSet in interface SortedSet<T>
  - subSet
```
public ExtendedSet<T> subSet(T fromElement,
                    T toElement)
```
    Specified by:
    
    subSet in interface ExtendedSet<T>
    
    Specified by:
    
    subSet in interface SortedSet<T>
  - tailSet
```
public ExtendedSet<T> tailSet(T fromElement)
```
    Specified by:
    
    tailSet in interface ExtendedSet<T>
    
    Specified by:
    
    tailSet in interface SortedSet<T>
  - first
```
public T first()
```
    Specified by:
    
    first in interface SortedSet<T>
  - last
```
public T last()
```
    Specified by:
    
    last in interface SortedSet<T>
  - clone
```
public ExtendedSet<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>
    
    Overrides:
    
    clone in class Object
    
    Returns:
    cloned object
  - bitmapCompressionRatio
```
public abstract 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>
    
    Returns:
    the compression factor
  - collectionCompressionRatio
```
public abstract 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>
    
    Returns:
    the compression factor
  - descendingIterator
```
public ExtendedSet.ExtendedIterator<T> descendingIterator()
```
    Gets the descending order iterator over the elements of type T
    
    Specified by:
    
    descendingIterator in interface ExtendedSet<T>
    
    Returns:
    descending iterator
  - descending
```
public Iterable<T> descending()
```
    Allows to use the Java "for-each" statement in descending order
    
    Specified by:
    
    descending in interface ExtendedSet<T>
    
    Returns:
    Iterable instance to iterate items in descending order
  - powerSet
```
public List<? extends ExtendedSet<T>> powerSet()
```
    Computes the power-set of the current set.
    It is a particular implementation of the algorithm Apriori (see: Rakesh Agrawal, Ramakrishnan Srikant, Fast Algorithms for Mining Association Rules in Large Databases, in Proceedings of the 20^th International Conference on Very Large Data Bases, p.487-499, 1994). The returned power-set does not contain the empty set.
    The subsets composing the powerset are returned in a list that is sorted according to the lexicographical order provided by the sorted set.
    
    Specified by:
    
    powerSet in interface ExtendedSet<T>
    
    Returns:
    the power-set
    See Also:
    ExtendedSet.powerSet(int, int), ExtendedSet.powerSetSize()
  - powerSet
```
public List<? extends ExtendedSet<T>> powerSet(int min,
                                      int max)
```
    Computes a subset of the power-set of the current set, composed by those subsets that have cardinality between min and max.
    It is a particular implementation of the algorithm Apriori (see: Rakesh Agrawal, Ramakrishnan Srikant, Fast Algorithms for Mining Association Rules in Large Databases, in Proceedings of the 20^th International Conference on Very Large Data Bases, p.487-499, 1994). The power-set does not contains the empty set.
    The subsets composing the powerset are returned in a list that is sorted according to the lexicographical order provided by the sorted set.
    
    Specified by:
    
    powerSet in interface ExtendedSet<T>
    
    Parameters:
    min - minimum subset size (greater than zero)
    max - maximum subset size
    
    Returns:
    the power-set
    See Also:
    ExtendedSet.powerSet(), ExtendedSet.powerSetSize(int, int)
  - powerSetSize
```
public int powerSetSize()
```
    Computes the power-set size of the current set.
    The power-set does not contains the empty set.
    
    Specified by:
    
    powerSetSize in interface ExtendedSet<T>
    
    Returns:
    the power-set size
    See Also:
    ExtendedSet.powerSet()
  - powerSetSize
```
public int powerSetSize(int min,
               int max)
```
    Computes the power-set size of the current set, composed by those subsets that have cardinality between min and max.
    The returned power-set does not contain the empty set.
    
    Specified by:
    
    powerSetSize in interface ExtendedSet<T>
    
    Parameters:
    min - minimum subset size (greater than zero)
    max - maximum subset size
    
    Returns:
    the power-set size
    See Also:
    ExtendedSet.powerSet(int, int)
  - compareTo
```
public int compareTo(ExtendedSet<T> o)
```
    Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. An IntSet instance A is less than another IntSet instance B if B-A (that is, the elements in B that are not contained in A) contains at least one element that is greater than all the elements in A-B.
    The implementor must ensure sgn(x.compareTo(y)) == -sgn(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception iff y.compareTo(x) throws an exception.)
    The implementor must also ensure that the relation is transitive: (x.compareTo(y)>0 && y.compareTo(z)>0) implies x.compareTo(z)>0.
    Finally, the implementor must ensure that x.compareTo(y)==0 implies that sgn(x.compareTo(z)) == sgn(y.compareTo(z)), for all z.
    It is strongly recommended, but not strictly required that (x.compareTo(y)==0) == (x.equals(y)). Generally speaking, any class that implements the Comparable interface and violates this condition should clearly indicate this fact. The recommended language is "Note: this class has a natural ordering that is inconsistent with equals."
    In the foregoing description, the notation sgn(expression ) designates the mathematical signum function, which is defined to return one of -1, 0, or 1 according to whether the value of expression is negative, zero or positive.
    
    Specified by:
    
    compareTo in interface ExtendedSet<T>
    
    Specified by:
    
    compareTo in interface Comparable<ExtendedSet<T>>
    
    Parameters:
    o - the object to be compared.
    
    Returns:
    a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
  - 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>
    
    Parameters:
    from - first element
    to - last element
  - clear
```
public void clear(T from,
         T to)
```
    Removes from 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:
    
    clear in interface ExtendedSet<T>
    
    Parameters:
    from - first element
    to - last element
  - flip
```
public void flip(T e)
```
    Adds the element if it not existing, or removes it if existing
    
    Specified by:
    
    flip in interface ExtendedSet<T>
    
    Parameters:
    e - element to flip
    See Also:
    ExtendedSet.symmetricDifference(Collection)
  - get
```
public T get(int i)
```
    Gets the i^th element of the set
    
    Specified by:
    
    get in interface ExtendedSet<T>
    
    Parameters:
    i - position of the element in the sorted set
    
    Returns:
    the i^th element of the set
  - indexOf
```
public int indexOf(T e)
```
    Provides position of element within the set.
    It returns -1 if the element does not exist within the set.
    
    Specified by:
    
    indexOf in interface ExtendedSet<T>
    
    Parameters:
    e - element of the set
    
    Returns:
    the element position
  - unmodifiable
```
public ExtendedSet<T> unmodifiable()
```
    Gets the read-only version of the current set
    
    Specified by:
    
    unmodifiable in interface ExtendedSet<T>
    
    Returns:
    the read-only version of the current set
  - iterator
```
public abstract ExtendedSet.ExtendedIterator<T> iterator()
```
    Specified by:
    
    iterator in interface ExtendedSet<T>
    
    Specified by:
    
    iterator in interface Iterable<T>
    
    Specified by:
    
    iterator in interface Collection<T>
    
    Specified by:
    
    iterator in interface Set<T>
    
    Specified by:
    
    iterator in class AbstractCollection<T>
  - jaccardSimilarity
```
public double jaccardSimilarity(ExtendedSet<T> other)
```
    Computes the Jaccard similarity coefficient between this set and the given set.
    The coefficient is defined as |A intersection B| / |A union B|.
    
    Specified by:
    
    jaccardSimilarity in interface ExtendedSet<T>
    
    Parameters:
    other - the other set
    
    Returns:
    the Jaccard similarity coefficient
    See Also:
    ExtendedSet.jaccardDistance(ExtendedSet)
  - jaccardDistance
```
public double jaccardDistance(ExtendedSet<T> other)
```
    Computes the Jaccard distance between this set and the given set.
    The coefficient is defined as 1 - ExtendedSet.jaccardSimilarity(ExtendedSet).
    
    Specified by:
    
    jaccardDistance in interface ExtendedSet<T>
    
    Parameters:
    other - the other set
    
    Returns:
    the Jaccard distance
    See Also:
    ExtendedSet.jaccardSimilarity(ExtendedSet)
  - weightedJaccardSimilarity
```
public double weightedJaccardSimilarity(ExtendedSet<T> other)
```
    Computes the weighted version of the Jaccard similarity coefficient between this set and the given set.
    The coefficient is defined as sum of min(A_i, B_i) / sum of max(A_i, B_i).
    NOTE: T must be a number, namely one of Integer, Double, Float, Byte, Long, Short.
    
    Specified by:
    
    weightedJaccardSimilarity in interface ExtendedSet<T>
    
    Parameters:
    other - the other set
    
    Returns:
    the weighted Jaccard similarity coefficient
    See Also:
    ExtendedSet.weightedJaccardDistance(ExtendedSet)
  - weightedJaccardDistance
```
public double weightedJaccardDistance(ExtendedSet<T> other)
```
    Computes the weighted version of the Jaccard distance between this set and the given set.
    The coefficient is defined as 1 - ExtendedSet.weightedJaccardSimilarity(ExtendedSet).
    NOTE: T must be a number, namely one of Integer, Double, Float, Byte, Long, Short.
    
    Specified by:
    
    weightedJaccardDistance in interface ExtendedSet<T>
    
    Parameters:
    other - the other set
    
    Returns:
    the weighted Jaccard distance
    See Also:
    ExtendedSet.weightedJaccardSimilarity(ExtendedSet)
  - convert
```
public ExtendedSet<T> convert(Object... e)
```
    Converts a given integer array into an instance of the current class
    
    Specified by:
    
    convert in interface ExtendedSet<T>
    
    Parameters:
    e - objects to use to generate the new instance
    
    Returns:
    the converted collection
    See Also:
    ExtendedSet.convert(Collection)
  - convert
```
public ExtendedSet<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>
    
    Parameters:
    c - collection to use to generate the new instance
    
    Returns:
    the converted collection
    See Also:
    ExtendedSet.convert(Object...)
  - debugInfo
```
public String debugInfo()
```
    Prints debug info about the given ExtendedSet implementation
    
    Specified by:
    
    debugInfo in interface ExtendedSet<T>
    
    Returns:
    a string that describes the internal representation of the instance

Class AbstractExtendedSet<T>

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.util.AbstractSet

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface it.uniroma3.mat.extendedset.ExtendedSet

Methods inherited from interface java.util.SortedSet

Methods inherited from interface java.util.Set

Constructor Detail

AbstractExtendedSet

Method Detail

intersection

union

difference

symmetricDifference

complemented

containsAny

containsAtLeast

intersectionSize

unionSize

symmetricDifferenceSize

differenceSize

complementSize

empty

headSet

subSet

tailSet

first

last

clone

bitmapCompressionRatio

collectionCompressionRatio

descendingIterator

descending

powerSet

powerSet

powerSetSize

powerSetSize

compareTo

fill

clear

flip

get

indexOf

unmodifiable

iterator

jaccardSimilarity

jaccardDistance

weightedJaccardSimilarity

weightedJaccardDistance

convert

convert

debugInfo