jsat.utils

Class IntSet

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<Integer>

jsat.utils.IntSet

All Implemented Interfaces:

Serializable, Iterable<Integer>, Collection<Integer>, Set<Integer>

public class IntSet
extends AbstractSet<Integer>
implements Serializable

A utility class for efficiently storing a set of integers. The implementation is based on Algorithm D (Open addressing with double hashing) from Knuth's TAOCP page 528.

Author:

Edward Raff

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IntSet() Creates a new empty integer set
IntSet(Collection<Integer> collection) Creates a set of integers from the given collection
IntSet(int capacity) Creates an empty integer set pre-allocated to store a specific number of items
IntSet(int capacity, float loadFactor) Creates an empty integer set pre-allocated to store a specific number of items
IntSet(Set<Integer> set) Creates a new set of integers from the given set

Method Summary

Modifier and Type	Method and Description
boolean	add(int e)
boolean	add(Integer e)
void	clear()
boolean	contains(int o)
boolean	contains(Object o)
static IntSet	from(int... ints) Creates a set of integers from the given list of integers.
Iterator<Integer>	iterator()
boolean	remove(int key)
boolean	remove(Object key)
int	size()

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, isEmpty, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Set

addAll, containsAll, isEmpty, retainAll, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

IntSet

public IntSet()

Creates a new empty integer set

IntSet

public IntSet(int capacity)

Creates an empty integer set pre-allocated to store a specific number of items

Parameters:

capacity - the number of items to store

IntSet

public IntSet(int capacity,
              float loadFactor)

Creates an empty integer set pre-allocated to store a specific number of items

Parameters:

capacity - the number of items to store

loadFactor - the maximum ratio of used to un-used storage

IntSet

public IntSet(Set<Integer> set)

Creates a new set of integers from the given set

Parameters:

set - the set of integers to create a copy of

IntSet

public IntSet(Collection<Integer> collection)

Creates a set of integers from the given collection

Parameters:

collection - a collection of integers to create a set from

Method Detail

from

public static IntSet from(int... ints)

Creates a set of integers from the given list of integers.

Parameters:

ints - a list of integers to create a set from

Returns:

a set of integers of all the unique integers in the given list

clear

public void clear()

Specified by:

clear in interface Collection<Integer>

Specified by:

clear in interface Set<Integer>

Overrides:

clear in class AbstractCollection<Integer>

add

public boolean add(Integer e)

Specified by:

add in interface Collection<Integer>

Specified by:

add in interface Set<Integer>

Overrides:

add in class AbstractCollection<Integer>

add

public boolean add(int e)

Parameters:

e - element to be added to this set

Returns:

true if this set did not already contain the specified element

contains

public boolean contains(int o)

remove

public boolean remove(Object key)

Specified by:

remove in interface Collection<Integer>

Specified by:

remove in interface Set<Integer>

Overrides:

remove in class AbstractCollection<Integer>

remove

public boolean remove(int key)

Parameters:

key - the value from the set to remove

Returns:

true if this set contained the specified element

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<Integer>

Specified by:

contains in interface Set<Integer>

Overrides:

contains in class AbstractCollection<Integer>

iterator

public Iterator<Integer> iterator()

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 AbstractCollection<Integer>

size

public int size()

Specified by:

size in interface Collection<Integer>

Specified by:

size in interface Set<Integer>

Specified by:

size in class AbstractCollection<Integer>