LongSet (com.metamx:extendedset 1.5.0-mmx API)

java.lang.Object
- it.uniroma3.mat.extendedset.wrappers.LongSet

All Implemented Interfaces:

Serializable, Cloneable, Comparable<LongSet>, Iterable<Long>
```
public class LongSet
extends Object
implements Cloneable, Comparable<LongSet>, Serializable, Iterable<Long>
```
Very similar to ExtendedSet but for the primitive long type.

Version:

$Id: LongSet.java 154 2011-05-30 22:19:24Z cocciasik $

Author:

Alessandro Colantonio

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class LongSet.ExtendedLongIterator
A Iterator -like interface that allows to "skip" some elements of the set

Nested Classes
Modifier and Type	Class and Description
`class`	`LongSet.ExtendedLongIterator` A `Iterator` -like interface that allows to "skip" some elements of the set

Constructor Summary

Constructors
Constructor and Description

LongSet(IntSet block)
Creates an empty set

Constructors
Constructor and Description
`LongSet(IntSet block)` Creates an empty set

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(long i)` Adds the specified element to this set if it is not already present.
`boolean`	`addAll(LongSet other)` Adds all of the elements in the specified collection to this set if they're not already present.
`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()` Removes all of the elements from this set.
`void`	`clear(long from, long to)` Removes from the set all the elements between `first` and `last`, both included.
`LongSet`	`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.)
`int`	`compareTo(LongSet o)`
`void`	`complement()` Complements the current set.
`LongSet`	`complemented()` Generates the complement set.
`long`	`complementSize()` Computes the complement set size.
`boolean`	`contains(long i)` Returns `true` if this set contains the specified element.
`boolean`	`containsAll(LongSet other)` Returns `true` if this set contains all of the elements of the specified collection.
`boolean`	`containsAny(LongSet other)` Returns `true` if the specified `LongSet` instance contains any elements that are also contained within this `LongSet` instance
`boolean`	`containsAtLeast(LongSet other, long minElements)` Returns `true` if the specified `LongSet` instance contains at least `minElements` elements that are also contained within this `LongSet` instance
`LongSet`	`convert(Collection<Long> a)` Converts a given array into an instance of the current class.
`LongSet`	`convert(long... a)` Converts a given array into an instance of the current class.
`String`	`debugInfo()` Prints debug info about the given `LongSet` implementation
`LongSet.ExtendedLongIterator`	`descendingLongIterator()`
`LongSet`	`difference(LongSet other)` Generates the difference set
`long`	`differenceSize(LongSet other)` Computes the difference set size.
`LongSet`	`empty()` Generates an empty set
`IntSet`	`emptyBlock()`
`boolean`	`equals(Object obj)`
`void`	`fill(long from, long to)` Adds to the set all the elements between `first` and `last`, both included.
`long`	`first()` Returns the first (lowest) element currently in this set.
`void`	`flip(long e)` Adds the element if it not existing, or removes it if existing
`long`	`get(long index)` Gets the `i`^th element of the set
`int`	`hashCode()`
`long`	`indexOf(long i)` Provides position of element within the set.
`LongSet`	`intersection(LongSet other)` Generates the intersection set
`long`	`intersectionSize(LongSet other)` Computes the intersection set size.
`boolean`	`isEmpty()`
`Iterator<Long>`	`iterator()`
`long`	`last()` Returns the last (highest) element currently in this set.
`LongSet.ExtendedLongIterator`	`longIterator()`
`boolean`	`remove(long i)` Removes the specified element from this set if it is present.
`boolean`	`removeAll(LongSet other)` Removes from this set all of its elements that are contained in the specified collection.
`boolean`	`retainAll(LongSet other)` Retains only the elements in this set that are contained in the specified collection.
`long`	`size()`
`LongSet`	`symmetricDifference(LongSet other)` Generates the symmetric difference set
`long`	`symmetricDifferenceSize(LongSet other)` Computes the symmetric difference set size.
`long[]`	`toArray()`
`long[]`	`toArray(long[] a)` Returns an array containing all of the elements in this set.
`String`	`toString()`
`LongSet`	`union(LongSet other)` Generates the union set
`long`	`unionSize(LongSet other)` Computes the union set size.

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - LongSet
```
public LongSet(IntSet block)
```
    Creates an empty set
    
    Parameters:
    
    block - IntSet instance internally used to represent Long values. It can be non-empty.
- Method Detail
  - emptyBlock
```
public IntSet emptyBlock()
```
    Returns:
    
    an empty IntSet instance of the same type of that of internally used to represent integers
  - retainAll
```
public boolean retainAll(LongSet other)
```
    Retains only the elements in this set that are contained in the specified collection. In other words, removes from this set all of its elements that are not contained in the specified collection.
    
    Parameters:
    
    other - collection containing elements to be retained in this set
    
    Returns:
    
    true if this set changed as a result of the call
    
    Throws:
    
    NullPointerException - if this set contains a null element and the specified collection does not permit null elements (optional), or if the specified collection is null
    
    See Also:
    
    remove(long)
  - intersection
```
public LongSet intersection(LongSet other)
```
    Generates the intersection set
    
    Parameters:
    
    other - LongSet instance that represents the right operand
    
    Returns:
    
    the result of the operation
    
    See Also:
    
    retainAll(LongSet)
  - addAll
```
public boolean addAll(LongSet other)
```
    Adds all of the elements in the specified collection to this set if they're not already present.
    
    Parameters:
    
    other - collection containing elements to be added to this set
    
    Returns:
    
    true if this set changed as a result of the call
    
    Throws:
    
    NullPointerException - if the specified collection contains one or more null elements and this set does not permit null elements, or if the specified collection is null
    
    IllegalArgumentException - if some property of an element of the specified collection prevents it from being added to this set
    
    See Also:
    
    add(long)
  - union
```
public LongSet union(LongSet other)
```
    Generates the union set
    
    Parameters:
    
    other - LongSet instance that represents the right operand
    
    Returns:
    
    the result of the operation
    
    See Also:
    
    addAll(LongSet)
  - removeAll
```
public boolean removeAll(LongSet other)
```
    Removes from this set all of its elements that are contained in the specified collection.
    
    Parameters:
    
    other - collection containing elements to be removed from this set
    
    Returns:
    
    true if this set changed as a result of the call
    
    Throws:
    
    NullPointerException - if this set contains a null element and the specified collection does not permit null elements (optional), or if the specified collection is null
    
    See Also:
    
    remove(long), contains(long)
  - difference
```
public LongSet difference(LongSet other)
```
    Generates the difference set
    
    Parameters:
    
    other - LongSet instance that represents the right operand
    
    Returns:
    
    the result of the operation
    
    See Also:
    
    removeAll(LongSet)
  - symmetricDifference
```
public LongSet symmetricDifference(LongSet other)
```
    Generates the symmetric difference set
    
    Parameters:
    
    other - LongSet instance that represents the right operand
    
    Returns:
    
    the result of the operation
    
    See Also:
    
    flip(long)
  - complemented
```
public LongSet complemented()
```
    Generates the complement set. The returned set is represented by all the elements strictly less than last() that do not exist in the current set.
    
    Returns:
    
    the complement set
    
    See Also:
    
    complement()
  - complement
```
public void complement()
```
    Complements the current set. The modified set is represented by all the elements strictly less than last() that do not exist in the current set.
    
    See Also:
    
    complemented()
  - intersectionSize
```
public long intersectionSize(LongSet other)
```
    Computes the intersection set size.
    This is faster than calling intersection(LongSet) and then size()
    
    Parameters:
    
    other - LongSet instance that represents the right operand
    
    Returns:
    
    the size
  - unionSize
```
public long unionSize(LongSet other)
```
    Computes the union set size.
    This is faster than calling union(LongSet) and then size()
    
    Parameters:
    
    other - LongSet instance that represents the right operand
    
    Returns:
    
    the size
  - symmetricDifferenceSize
```
public long symmetricDifferenceSize(LongSet other)
```
    Computes the symmetric difference set size.
    This is faster than calling symmetricDifference(LongSet) and then size()
    
    Parameters:
    
    other - LongSet instance that represents the right operand
    
    Returns:
    
    the size
  - differenceSize
```
public long differenceSize(LongSet other)
```
    Computes the difference set size.
    This is faster than calling difference(LongSet) and then size()
    
    Parameters:
    
    other - LongSet instance that represents the right operand
    
    Returns:
    
    the size
  - complementSize
```
public long complementSize()
```
    Computes the complement set size.
    This is faster than calling complemented() and then size()
    
    Returns:
    
    the size
  - empty
```
public LongSet empty()
```
    Generates an empty set
    
    Returns:
    
    the empty set
  - clone
```
public LongSet clone()
```
    See the clone() of Object
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    cloned object
  - 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.)
    
    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.)
    
    Returns:
    
    the compression factor
  - longIterator
```
public LongSet.ExtendedLongIterator longIterator()
```
    Returns:
    
    a LongSet.ExtendedLongIterator instance to iterate over the set
  - descendingLongIterator
```
public LongSet.ExtendedLongIterator descendingLongIterator()
```
    Returns:
    
    a LongSet.ExtendedLongIterator instance to iterate over the set in descending order
  - iterator
```
public Iterator<Long> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Long>
  - debugInfo
```
public String debugInfo()
```
    Prints debug info about the given LongSet implementation
    
    Returns:
    
    a string that describes the internal representation of the instance
  - fill
```
public void fill(long from,
                 long to)
```
    Adds to the set all the elements between first and last, both included.
    
    Parameters:
    
    from - first element
    
    to - last element
  - clear
```
public void clear(long from,
                  long to)
```
    Removes from the set all the elements between first and last, both included.
    
    Parameters:
    
    from - first element
    
    to - last element
  - flip
```
public void flip(long e)
```
    Adds the element if it not existing, or removes it if existing
    
    Parameters:
    
    e - element to flip
    
    See Also:
    
    symmetricDifference(LongSet)
  - get
```
public long get(long index)
```
    Gets the i^th element of the set
    
    Parameters:
    
    index - position of the element in the sorted set
    
    Returns:
    
    the i^th element of the set
    
    Throws:
    
    IndexOutOfBoundsException - if i is less than zero, or greater or equal to size()
  - indexOf
```
public long indexOf(long i)
```
    Provides position of element within the set.
    It returns -1 if the element does not exist within the set.
    
    Parameters:
    
    i - element of the set
    
    Returns:
    
    the element position
  - convert
```
public LongSet convert(long... a)
```
    Converts a given array into an instance of the current class.
    
    Parameters:
    
    a - array to use to generate the new instance
    
    Returns:
    
    the converted collection
  - convert
```
public LongSet convert(Collection<Long> a)
```
    Converts a given array into an instance of the current class.
    
    Parameters:
    
    a - array to use to generate the new instance
    
    Returns:
    
    the converted collection
  - first
```
public long first()
```
    Returns the first (lowest) element currently in this set.
    
    Returns:
    
    the first (lowest) element currently in this set
    
    Throws:
    
    NoSuchElementException - if this set is empty
  - last
```
public long last()
```
    Returns the last (highest) element currently in this set.
    
    Returns:
    
    the last (highest) element currently in this set
    
    Throws:
    
    NoSuchElementException - if this set is empty
  - size
```
public long size()
```
    Returns:
    
    the number of elements in this set (its cardinality)
  - isEmpty
```
public boolean isEmpty()
```
    Returns:
    
    true if this set contains no elements
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - contains
```
public boolean contains(long i)
```
    Returns true if this set contains the specified element.
    
    Parameters:
    
    i - element whose presence in this set is to be tested
    
    Returns:
    
    true if this set contains the specified element
  - add
```
public boolean add(long i)
```
    Adds the specified element to this set if it is not already present. It ensures that sets never contain duplicate elements.
    
    Parameters:
    
    i - element to be added to this set
    
    Returns:
    
    true if this set did not already contain the specified element
    
    Throws:
    
    IllegalArgumentException - if some property of the specified element prevents it from being added to this set
  - remove
```
public boolean remove(long i)
```
    Removes the specified element from this set if it is present.
    
    Parameters:
    
    i - object to be removed from this set, if present
    
    Returns:
    
    true if this set contained the specified element
    
    Throws:
    
    UnsupportedOperationException - if the remove operation is not supported by this set
  - containsAll
```
public boolean containsAll(LongSet other)
```
    Returns true if this set contains all of the elements of the specified collection.
    
    Parameters:
    
    other - collection to be checked for containment in this set
    
    Returns:
    
    true if this set contains all of the elements of the specified collection
    
    Throws:
    
    NullPointerException - if the specified collection contains one or more null elements and this set does not permit null elements (optional), or if the specified collection is null
    
    See Also:
    
    contains(long)
  - containsAny
```
public boolean containsAny(LongSet other)
```
    Returns true if the specified LongSet instance contains any elements that are also contained within this LongSet instance
    
    Parameters:
    
    other - LongSet to intersect with
    
    Returns:
    
    a boolean indicating whether this LongSet intersects the specified LongSet.
  - containsAtLeast
```
public boolean containsAtLeast(LongSet other,
                               long minElements)
```
    Returns true if the specified LongSet instance contains at least minElements elements that are also contained within this LongSet instance
    
    Parameters:
    
    other - LongSet instance to intersect with
    
    minElements - minimum number of elements to be contained within this LongSet instance
    
    Returns:
    
    a boolean indicating whether this LongSet intersects the specified LongSet.
    
    Throws:
    
    IllegalArgumentException - if minElements < 1
  - clear
```
public void clear()
```
    Removes all of the elements from this set. The set will be empty after this call returns.
  - toArray
```
public long[] toArray()
```
    Returns:
    
    an array containing all the elements in this set, in the same order.
  - toArray
```
public long[] toArray(long[] a)
```
    Returns an array containing all of the elements in this set.
    If this set fits in the specified array with room to spare (i.e., the array has more elements than this set), the element in the array immediately following the end of the set are left unchanged.
    
    Parameters:
    
    a - the array into which the elements of this set are to be stored.
    
    Returns:
    
    the array containing all the elements in this set
    
    Throws:
    
    NullPointerException - if the specified array is null
    
    IllegalArgumentException - if this set does not fit in the specified array
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - compareTo
```
public int compareTo(LongSet o)
```
    Specified by:
    
    compareTo in interface Comparable<LongSet>

Class LongSet

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

LongSet

Method Detail

emptyBlock

retainAll

intersection

addAll

union

removeAll

difference

symmetricDifference

complemented

complement

intersectionSize

unionSize

symmetricDifferenceSize

differenceSize

complementSize

empty

clone

bitmapCompressionRatio

collectionCompressionRatio

longIterator

descendingLongIterator

iterator

debugInfo

fill

clear

flip

get

indexOf

convert

convert

first

last

size

isEmpty

hashCode

equals

contains

add

remove

containsAll

containsAny

containsAtLeast

clear

toArray

toArray

toString

compareTo