it.unimi.dsi.fastutil.ints
Class IntLinkedOpenHashSet

java.lang.Object
  extended by it.unimi.dsi.fastutil.ints.AbstractIntCollection
      extended by it.unimi.dsi.fastutil.ints.AbstractIntSet
          extended by it.unimi.dsi.fastutil.ints.AbstractIntSortedSet
              extended by it.unimi.dsi.fastutil.ints.IntLinkedOpenHashSet
All Implemented Interfaces:
Hash, IntCollection, IntIterable, IntSet, IntSortedSet, Serializable, Cloneable, Iterable<Integer>, Collection<Integer>, Set<Integer>, SortedSet<Integer>

public class IntLinkedOpenHashSet
extends AbstractIntSortedSet
implements Serializable, Cloneable, Hash

A type-specific linked hash set with with a fast, small-footprint implementation.

Instances of this class use a hash table to represent a set. The table is enlarged as needed when new entries are created, but it is never made smaller (even on a clear()). A family of trimming methods lets you control the size of the table; this is particularly useful if you reuse instances of this class.

The enlargement speed is controlled by the growth factor, a positive number. If the growth factor is p, then the table is enlarged each time roughly by a factor 2p/16. By default, p is Hash.DEFAULT_GROWTH_FACTOR, which means that the table is doubled at each enlargement, but one can easily set more or less aggressive policies by calling growthFactor(int) (note that the growth factor is not serialized: deserialized tables gets the default growth factor).

This class implements the interface of a sorted set, so to allow easy access of the iteration order: for instance, you can get the first element in iteration order with AbstractIntSortedSet.first() without having to create an iterator; however, this class partially violates the SortedSet contract because all subset methods throw an exception and comparator() returns always null.

The iterators provided by this class are type-specific list iterators. However, creation of an iterator using a starting point is going to be very expensive, as the chosen starting point must be linearly searched for, unless it is AbstractIntSortedSet.last(), in which case the iterator is created in constant time.

Note that deletions in a linked table require scanning the list until the element to be removed is found. The only exceptions are the first element, the last element, and deletions performed using an iterator.

See Also:
Hash, HashCommon, Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.Hash
Hash.Strategy<K>
 
Field Summary
static long serialVersionUID
           
 
Fields inherited from interface it.unimi.dsi.fastutil.Hash
DEFAULT_GROWTH_FACTOR, DEFAULT_INITIAL_SIZE, DEFAULT_LOAD_FACTOR, FAST_LOAD_FACTOR, FREE, OCCUPIED, PRIMES, REMOVED, VERY_FAST_LOAD_FACTOR
 
Constructor Summary
IntLinkedOpenHashSet()
          Creates a new hash set with Hash.DEFAULT_INITIAL_SIZE elements and Hash.DEFAULT_LOAD_FACTOR as load factor.
IntLinkedOpenHashSet(Collection<? extends Integer> c)
          Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor copying a given collection.
IntLinkedOpenHashSet(Collection<? extends Integer> c, float f)
          Creates a new hash set copying a given collection.
IntLinkedOpenHashSet(int n)
          Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor.
IntLinkedOpenHashSet(int[] a)
          Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor copying the elements of an array.
IntLinkedOpenHashSet(int[] a, float f)
          Creates a new hash set copying the elements of an array.
IntLinkedOpenHashSet(int[] a, int offset, int length)
          Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor and fills it with the elements of a given array.
IntLinkedOpenHashSet(int[] a, int offset, int length, float f)
          Creates a new hash set and fills it with the elements of a given array.
IntLinkedOpenHashSet(IntCollection c)
          Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor copying a given type-specific collection.
IntLinkedOpenHashSet(IntCollection c, float f)
          Creates a new hash set copying a given type-specific collection.
IntLinkedOpenHashSet(int n, float f)
          Creates a new hash set.
IntLinkedOpenHashSet(IntIterator i)
          Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor using elements provided by a type-specific iterator.
IntLinkedOpenHashSet(IntIterator i, float f)
          Creates a new hash set using elements provided by a type-specific iterator.
IntLinkedOpenHashSet(Iterator<?> i)
          Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor using elements provided by an iterator.
IntLinkedOpenHashSet(Iterator<?> i, float f)
          Creates a new hash set using elements provided by an iterator.
 
Method Summary
 boolean add(int k)
           
 void clear()
           
 Object clone()
          Returns a deep copy of this set.
 IntComparator comparator()
          Returns the comparator associated with this sorted set, or null if it uses its elements' natural ordering.
 boolean contains(int k)
           
 int firstInt()
          Returns the first element of this set in iteration order.
 int growthFactor()
          Gets the growth factor.
 void growthFactor(int growthFactor)
          Sets the growth factor.
 int hashCode()
          Returns a hash code for this set.
 IntSortedSet headSet(int to)
           
 boolean isEmpty()
           
 IntBidirectionalIterator iterator()
          Returns a type-specific iterator on the elements of this collection.
 IntBidirectionalIterator iterator(int from)
          Returns a type-specific list iterator on the elements in this set, starting from a given element of the set.
 int lastInt()
          Returns the last element of this set in iteration order.
 boolean rehash()
          Rehashes this set without changing the table size.
 boolean remove(int k)
          Removes an element from this set.
 int size()
           
 IntSortedSet subSet(int from, int to)
           
 IntSortedSet tailSet(int from)
           
 boolean trim()
          Rehashes this set, making the table as small as possible.
 boolean trim(int n)
          Rehashes this set if the table is too large.
 
Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractIntSortedSet
first, headSet, intIterator, last, subSet, tailSet
 
Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractIntSet
equals, rem, remove
 
Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractIntCollection
add, addAll, addAll, contains, containsAll, containsAll, rem, removeAll, removeAll, retainAll, retainAll, toArray, toArray, toArray, toIntArray, toIntArray, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface it.unimi.dsi.fastutil.ints.IntCollection
addAll, containsAll, rem, removeAll, retainAll, toArray, toArray, toIntArray, toIntArray
 
Methods inherited from interface java.util.Set
add, addAll, contains, containsAll, equals, remove, removeAll, retainAll, toArray, toArray
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

IntLinkedOpenHashSet

public IntLinkedOpenHashSet(int n,
                            float f)
Creates a new hash set. The actual table size is the least available prime greater than n/f.

Parameters:
n - the expected number of elements in the hash set.
f - the load factor.
See Also:
Hash.PRIMES

IntLinkedOpenHashSet

public IntLinkedOpenHashSet(int n)
Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor.

Parameters:
n - the expected number of elements in the hash set.

IntLinkedOpenHashSet

public IntLinkedOpenHashSet()
Creates a new hash set with Hash.DEFAULT_INITIAL_SIZE elements and Hash.DEFAULT_LOAD_FACTOR as load factor.


IntLinkedOpenHashSet

public IntLinkedOpenHashSet(Collection<? extends Integer> c,
                            float f)
Creates a new hash set copying a given collection.

Parameters:
c - a Collection to be copied into the new hash set.
f - the load factor.

IntLinkedOpenHashSet

public IntLinkedOpenHashSet(Collection<? extends Integer> c)
Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor copying a given collection.

Parameters:
c - a Collection to be copied into the new hash set.

IntLinkedOpenHashSet

public IntLinkedOpenHashSet(IntCollection c,
                            float f)
Creates a new hash set copying a given type-specific collection.

Parameters:
c - a type-specific collection to be copied into the new hash set.
f - the load factor.

IntLinkedOpenHashSet

public IntLinkedOpenHashSet(IntCollection c)
Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor copying a given type-specific collection.

Parameters:
c - a type-specific collection to be copied into the new hash set.

IntLinkedOpenHashSet

public IntLinkedOpenHashSet(IntIterator i,
                            float f)
Creates a new hash set using elements provided by a type-specific iterator.

Parameters:
i - a type-specific iterator whose elements will fill the set.
f - the load factor.

IntLinkedOpenHashSet

public IntLinkedOpenHashSet(IntIterator i)
Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor using elements provided by a type-specific iterator.

Parameters:
i - a type-specific iterator whose elements will fill the set.

IntLinkedOpenHashSet

public IntLinkedOpenHashSet(Iterator<?> i,
                            float f)
Creates a new hash set using elements provided by an iterator.

Parameters:
i - an iterator whose elements will fill the set.
f - the load factor.

IntLinkedOpenHashSet

public IntLinkedOpenHashSet(Iterator<?> i)
Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor using elements provided by an iterator.

Parameters:
i - an iterator whose elements will fill the set.

IntLinkedOpenHashSet

public IntLinkedOpenHashSet(int[] a,
                            int offset,
                            int length,
                            float f)
Creates a new hash set and fills it with the elements of a given array.

Parameters:
a - an array whose elements will be used to fill the set.
offset - the first element to use.
length - the number of elements to use.
f - the load factor.

IntLinkedOpenHashSet

public IntLinkedOpenHashSet(int[] a,
                            int offset,
                            int length)
Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor and fills it with the elements of a given array.

Parameters:
a - an array whose elements will be used to fill the set.
offset - the first element to use.
length - the number of elements to use.

IntLinkedOpenHashSet

public IntLinkedOpenHashSet(int[] a,
                            float f)
Creates a new hash set copying the elements of an array.

Parameters:
a - an array to be copied into the new hash set.
f - the load factor.

IntLinkedOpenHashSet

public IntLinkedOpenHashSet(int[] a)
Creates a new hash set with Hash.DEFAULT_LOAD_FACTOR as load factor copying the elements of an array.

Parameters:
a - an array to be copied into the new hash set.
Method Detail

growthFactor

public void growthFactor(int growthFactor)
Sets the growth factor. Subsequent enlargements will increase the table size roughly by a multiplicative factor of 2p/16.

Parameters:
growthFactor - the new growth factor; it must be positive.

growthFactor

public int growthFactor()
Gets the growth factor.

Returns:
the growth factor of this set.
See Also:
growthFactor(int)

add

public boolean add(int k)
Specified by:
add in interface IntCollection
Overrides:
add in class AbstractIntCollection
See Also:
Collection.add(Object)

remove

public boolean remove(int k)
Description copied from interface: IntSet
Removes an element from this set.

Note that the corresponding method of the type-specific collection is rem(). This unfortunate situation is caused by the clash with the similarly named index-based method in the List interface.

Specified by:
remove in interface IntSet
Overrides:
remove in class AbstractIntSet
See Also:
Collection.remove(Object)

contains

public boolean contains(int k)
Specified by:
contains in interface IntCollection
See Also:
Collection.contains(Object)

clear

public void clear()
Specified by:
clear in interface Collection<Integer>
Specified by:
clear in interface Set<Integer>
Overrides:
clear in class AbstractIntCollection

firstInt

public int firstInt()
Returns the first element of this set in iteration order.

Specified by:
firstInt in interface IntSortedSet
Returns:
the first element in iteration order.
See Also:
SortedSet.first()

lastInt

public int lastInt()
Returns the last element of this set in iteration order.

Specified by:
lastInt in interface IntSortedSet
Returns:
the last element in iteration order.
See Also:
SortedSet.last()

tailSet

public IntSortedSet tailSet(int from)
Specified by:
tailSet in interface IntSortedSet
See Also:
SortedSet.tailSet(Object)

headSet

public IntSortedSet headSet(int to)
Specified by:
headSet in interface IntSortedSet
See Also:
SortedSet.headSet(Object)

subSet

public IntSortedSet subSet(int from,
                           int to)
Specified by:
subSet in interface IntSortedSet
See Also:
SortedSet.subSet(Object,Object)

comparator

public IntComparator comparator()
Description copied from interface: IntSortedSet
Returns the comparator associated with this sorted set, or null if it uses its elements' natural ordering.

Note that this specification strengthens the one given in SortedSet.comparator().

Specified by:
comparator in interface IntSortedSet
Specified by:
comparator in interface SortedSet<Integer>
See Also:
SortedSet.comparator()

iterator

public IntBidirectionalIterator iterator(int from)
Returns a type-specific list iterator on the elements in this set, starting from a given element of the set.

This method provides an iterator positioned immediately after the given element. That is, the next call to previous() will return from, whereas the next call to next() will return the element immediately after from. This allows to call iterator(last()) and obtain an iterator starting from the end of the iteration order.

Because of the way linking is implemented, generating an iterator using this method requires constant time only if the argument is last(). In all other cases, a linear search for the given element will be necessary.

Note that this method returns a bidirectional iterator, which, however, can be safely cast to a type-specific list iterator.

Specified by:
iterator in interface IntSortedSet
Parameters:
from - an element to start from.
Returns:
a type-specific list iterator starting at the given element.
Throws:
IllegalArgumentException - if from does not belong to the set.

iterator

public IntBidirectionalIterator iterator()
Description copied from interface: IntCollection
Returns a type-specific iterator on the elements of this collection.

Note that this specification strengthens the one given in Iterable.iterator(), which was already strengthened in the corresponding type-specific class, but was weakened by the fact that this interface extends Collection.

Specified by:
iterator in interface IntCollection
Specified by:
iterator in interface IntIterable
Specified by:
iterator in interface IntSet
Specified by:
iterator in interface IntSortedSet
Specified by:
iterator in interface Iterable<Integer>
Specified by:
iterator in interface Collection<Integer>
Specified by:
iterator in interface Set<Integer>
Specified by:
iterator in class AbstractIntSortedSet
Returns:
a type-specific iterator on the elements of this collection.

rehash

public boolean rehash()
Rehashes this set without changing the table size.

This method should be called when the set underwent numerous deletions and insertions. In this case, free entries become rare, and unsuccessful searches require probing all entries. For reasonable load factors this method is linear in the number of entries. You will need as much additional free memory as that occupied by the table.

If you need to reduce the table siza to fit exactly this set, you must use trim().

Returns:
true if there was enough memory to rehash the set, false otherwise.
See Also:
trim()

trim

public boolean trim()
Rehashes this set, making the table as small as possible.

This method rehashes the table to the smallest size satisfying the load factor. It can be used when the set will not be changed anymore, so to optimize access speed (by collecting deleted entries) and size.

If the table size is already the minimum possible, this method does nothing. If you want to guarantee rehashing, use rehash().

Returns:
true if there was enough memory to trim the set.
See Also:
trim(int), rehash()

trim

public boolean trim(int n)
Rehashes this set if the table is too large.

Let N be the smallest table size that can hold max(n,size()) entries, still satisfying the load factor. If the current table size is smaller than or equal to N, this method does nothing. Otherwise, it rehashes this set in a table of size N.

This method is useful when reusing sets. Clearing a set leaves the table size untouched. If you are reusing a set many times, you can call this method with a typical size to avoid keeping around a very large table just because of a few large transient sets.

Parameters:
n - the threshold for the trimming.
Returns:
true if there was enough memory to trim the set.
See Also:
trim(), rehash()

size

public int size()
Specified by:
size in interface Collection<Integer>
Specified by:
size in interface Set<Integer>

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface Collection<Integer>
Specified by:
isEmpty in interface Set<Integer>
Overrides:
isEmpty in class AbstractIntCollection

clone

public Object clone()
Returns a deep copy of this set.

This method performs a deep copy of this hash set; the data stored in the set, however, is not cloned. Note that this makes a difference only for object keys.

Overrides:
clone in class Object
Returns:
a deep copy of this set.

hashCode

public int hashCode()
Returns a hash code for this set. This method overrides the generic method provided by the superclass. Since equals() is not overriden, it is important that the value returned by this method is the same value as the one returned by the overriden method.

Specified by:
hashCode in interface Collection<Integer>
Specified by:
hashCode in interface Set<Integer>
Overrides:
hashCode in class AbstractIntSet
Returns:
a hash code for this set.