AbstractExtendedSet.FilteredSet (com.metamx:extendedset 1.3.10 API)

java.lang.Object
- it.uniroma3.mat.extendedset.AbstractExtendedSet.FilteredSet

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractExtendedSet.ExtendedSubSet, AbstractExtendedSet.UnmodifiableExtendedSet

Enclosing class:

AbstractExtendedSet<T>
```
protected abstract class AbstractExtendedSet.FilteredSet
extends Object
implements ExtendedSet<T>
```
Base class for AbstractExtendedSet.ExtendedSubSet and AbstractExtendedSet.UnmodifiableExtendedSet

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

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractExtendedSet.FilteredSet()

Constructors
Modifier	Constructor and Description
`protected`	`AbstractExtendedSet.FilteredSet()`

Method Summary

Methods
Modifier and Type	Method and Description
`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.)
`ExtendedSet<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()`
`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`	`contains(Object o)`
`boolean`	`containsAll(Collection<?> c)`
`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.
`ExtendedSet<T>`	`empty()` Generates an empty set
`boolean`	`equals(Object o)`
`T`	`first()`
`T`	`get(int i)` Gets the `i`^th element of the set
`int`	`hashCode()`
`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.
`boolean`	`isEmpty()`
`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 mins, int maxs)` 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 mins, int maxs)` Computes the power-set size of the current set, composed by those subsets that have cardinality between `min` and `max`.
`protected abstract ExtendedSet<T>`	`raw()`
`int`	`size()`
`ExtendedSet<T>`	`symmetricDifference(Collection<? extends T> other)` Generates the symmetric difference set
`int`	`symmetricDifferenceSize(Collection<? extends T> other)` Computes the symmetric difference set size.
`Object[]`	`toArray()`
`<X> X[]`	`toArray(X[] a)`
`String`	`toString()`
`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.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface it.uniroma3.mat.extendedset.ExtendedSet
clear, complement, fill, flip, headSet, subSet, tailSet

Methods inherited from interface java.util.Set
add, addAll, clear, remove, removeAll, retainAll

- Constructor Detail
  - AbstractExtendedSet.FilteredSet
```
protected AbstractExtendedSet.FilteredSet()
```
- Method Detail
  - raw
```
protected abstract ExtendedSet<T> raw()
```
    Returns:
    the container instance, namely the "internal" representation
  - convert
```
public ExtendedSet<T> convert(Collection<?> c)
```
    Description copied from interface: ExtendedSet
    
    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...)
  - convert
```
public ExtendedSet<T> convert(Object... e)
```
    Description copied from interface: ExtendedSet
    
    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)
  - clone
```
public ExtendedSet<T> clone()
```
    Description copied from interface: ExtendedSet
    
    See the clone() of Object
    
    Specified by:
    
    clone in interface ExtendedSet<T>
    
    Overrides:
    
    clone in class Object
    
    Returns:
    cloned object
  - empty
```
public ExtendedSet<T> empty()
```
    Description copied from interface: ExtendedSet
    
    Generates an empty set
    
    Specified by:
    
    empty in interface ExtendedSet<T>
    
    Returns:
    the empty set
  - comparator
```
public Comparator<? super T> comparator()
```
    Specified by:
    
    comparator in interface SortedSet<T>
  - unmodifiable
```
public ExtendedSet<T> unmodifiable()
```
    Description copied from interface: ExtendedSet
    
    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 ExtendedSet.ExtendedIterator<T> iterator()
```
    Description copied from interface: ExtendedSet
    
    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>
  - descendingIterator
```
public ExtendedSet.ExtendedIterator<T> descendingIterator()
```
    Description copied from interface: ExtendedSet
    
    Gets the descending order iterator over the elements of type T
    
    Specified by:
    
    descendingIterator in interface ExtendedSet<T>
    
    Returns:
    descending iterator
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Collection<T>
    
    Specified by:
    
    isEmpty in interface Set<T>
  - equals
```
public boolean equals(Object o)
```
    Specified by:
    
    equals in interface Collection<T>
    
    Specified by:
    
    equals in interface Set<T>
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Collection<T>
    
    Specified by:
    
    hashCode in interface Set<T>
    
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(ExtendedSet<T> o)
```
    Description copied from interface: ExtendedSet
    
    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.
  - first
```
public T first()
```
    Specified by:
    
    first in interface SortedSet<T>
  - last
```
public T last()
```
    Specified by:
    
    last in interface SortedSet<T>
  - bitmapCompressionRatio
```
public double bitmapCompressionRatio()
```
    Description copied from interface: ExtendedSet
    
    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 double collectionCompressionRatio()
```
    Description copied from interface: ExtendedSet
    
    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
  - powerSet
```
public List<? extends ExtendedSet<T>> powerSet()
```
    Description copied from interface: ExtendedSet
    
    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 mins,
                                      int maxs)
```
    Description copied from interface: ExtendedSet
    
    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:
    mins - minimum subset size (greater than zero)
    maxs - maximum subset size
    
    Returns:
    the power-set
    See Also:
    ExtendedSet.powerSet(), ExtendedSet.powerSetSize(int, int)
  - powerSetSize
```
public int powerSetSize()
```
    Description copied from interface: ExtendedSet
    
    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 mins,
               int maxs)
```
    Description copied from interface: ExtendedSet
    
    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:
    mins - minimum subset size (greater than zero)
    maxs - maximum subset size
    
    Returns:
    the power-set size
    See Also:
    ExtendedSet.powerSet(int, int)
  - toArray
```
public Object[] toArray()
```
    Specified by:
    
    toArray in interface Collection<T>
    
    Specified by:
    
    toArray in interface Set<T>
  - toArray
```
public <X> X[] toArray(X[] a)
```
    Specified by:
    
    toArray in interface Collection<T>
    
    Specified by:
    
    toArray in interface Set<T>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - complemented
```
public ExtendedSet<T> complemented()
```
    Description copied from interface: ExtendedSet
    
    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()
  - complementSize
```
public int complementSize()
```
    Description copied from interface: ExtendedSet
    
    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
  - size
```
public int size()
```
    Specified by:
    
    size in interface Collection<T>
    
    Specified by:
    
    size in interface Set<T>
  - contains
```
public boolean contains(Object o)
```
    Specified by:
    
    contains in interface Collection<T>
    
    Specified by:
    
    contains in interface Set<T>
  - descending
```
public Iterable<T> descending()
```
    Description copied from interface: ExtendedSet
    
    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
  - debugInfo
```
public String debugInfo()
```
    Description copied from interface: ExtendedSet
    
    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
  - get
```
public T get(int i)
```
    Description copied from interface: ExtendedSet
    
    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)
```
    Description copied from interface: ExtendedSet
    
    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
  - jaccardDistance
```
public double jaccardDistance(ExtendedSet<T> other)
```
    Description copied from interface: ExtendedSet
    
    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)
  - jaccardSimilarity
```
public double jaccardSimilarity(ExtendedSet<T> other)
```
    Description copied from interface: ExtendedSet
    
    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)
  - weightedJaccardDistance
```
public double weightedJaccardDistance(ExtendedSet<T> other)
```
    Description copied from interface: ExtendedSet
    
    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)
  - weightedJaccardSimilarity
```
public double weightedJaccardSimilarity(ExtendedSet<T> other)
```
    Description copied from interface: ExtendedSet
    
    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)
  - difference
```
public ExtendedSet<T> difference(Collection<? extends T> other)
```
    Description copied from interface: ExtendedSet
    
    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)
```
    Description copied from interface: ExtendedSet
    
    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)
  - intersection
```
public ExtendedSet<T> intersection(Collection<? extends T> other)
```
    Description copied from interface: ExtendedSet
    
    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)
```
    Description copied from interface: ExtendedSet
    
    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)
  - intersectionSize
```
public int intersectionSize(Collection<? extends T> other)
```
    Description copied from interface: ExtendedSet
    
    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
  - differenceSize
```
public int differenceSize(Collection<? extends T> other)
```
    Description copied from interface: ExtendedSet
    
    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
  - unionSize
```
public int unionSize(Collection<? extends T> other)
```
    Description copied from interface: ExtendedSet
    
    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)
```
    Description copied from interface: ExtendedSet
    
    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
  - containsAll
```
public boolean containsAll(Collection<?> c)
```
    Specified by:
    
    containsAll in interface Collection<T>
    
    Specified by:
    
    containsAll in interface Set<T>
  - containsAny
```
public boolean containsAny(Collection<? extends T> other)
```
    Description copied from interface: ExtendedSet
    
    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)
```
    Description copied from interface: ExtendedSet
    
    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.

Class AbstractExtendedSet.FilteredSet

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Set

Constructor Detail

AbstractExtendedSet.FilteredSet

Method Detail

raw

convert

convert

clone

empty

comparator

unmodifiable

iterator

descendingIterator

isEmpty

equals

hashCode

compareTo

first

last

bitmapCompressionRatio

collectionCompressionRatio

powerSet

powerSet

powerSetSize

powerSetSize

toArray

toArray

toString

complemented

complementSize

size

contains

descending

debugInfo

get

indexOf

jaccardDistance

jaccardSimilarity

weightedJaccardDistance

weightedJaccardSimilarity

difference

symmetricDifference

intersection

union

intersectionSize

differenceSize

unionSize

symmetricDifferenceSize

containsAll

containsAny

containsAtLeast