Class IntHashSet

java.lang.Object

org.eclipse.collections.impl.primitive.AbstractIntIterable

org.eclipse.collections.impl.set.primitive.AbstractIntSet

org.eclipse.collections.impl.set.mutable.primitive.IntHashSet

All Implemented Interfaces:

Externalizable, Serializable, MutableIntCollection, IntIterable, PrimitiveIterable, IntSet, MutableIntSet

public class IntHashSet
extends AbstractIntSet
implements MutableIntSet, Externalizable

This file was automatically generated from template file primitiveHashSet.stg.

Since:

3.0.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	IntHashSet.ImmutableIntHashSet
private class	IntHashSet.InternalIntIterator

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	CACHE_LINE_SIZE
private boolean	copyOnWrite
private static final int	DEFAULT_INITIAL_CAPACITY
private static final int	EMPTY
private static final int	INITIAL_LINEAR_PROBE
private static final int	KEY_SIZE
private int	occupiedWithData
private int	occupiedWithSentinels
private static final int	REMOVED
private static final long	serialVersionUID
private int[]	table
private int	zeroToThirtyOne
private int	zeroToThirtyOneOccupied

Constructor Summary

Constructors

Constructor	Description
IntHashSet()
IntHashSet(int initialCapacity)
IntHashSet(int... elements)
IntHashSet(IntIterable elements)
IntHashSet(IntHashSet set)

Method Summary

Modifier and Type	Method	Description
boolean	add(int element)
boolean	addAll(int... source)
boolean	addAll(IntIterable source)
protected void	allocateTable(int sizeToAllocate)
boolean	allSatisfy(IntPredicate predicate)	Returns true if all of the elements in the IntIterable return true for the specified predicate, otherwise returns false.
boolean	anySatisfy(IntPredicate predicate)	Returns true if any of the elements in the IntIterable return true for the specified predicate, otherwise returns false.
void	appendString(Appendable appendable, String start, String separator, String end)	Prints a string representation of this collection onto the given Appendable.
MutableIntSet	asSynchronized()
MutableIntSet	asUnmodifiable()
MutableSet<Integer>	boxed()
RichIterable<IntIterable>	chunk(int size)	Partitions elements in fixed size chunks.
void	clear()
<V> MutableSet<V>	collect(IntToObjectFunction<? extends V> function)	Returns a new collection with the results of applying the specified function on each element of the source collection.
<V, R extends Collection<V>> R	collect(IntToObjectFunction<? extends V> function, R target)	Same as IntIterable.collect(IntToObjectFunction) , only the results are added to the target Collection.
void	compact()	Deprecated. since 12.0 - Use trimToSize() instead
boolean	contains(int value)	Returns true if the value is contained in the IntIterable, and false if it is not.
private void	copyTable()
int	count(IntPredicate predicate)	Returns a count of the number of elements in the IntIterable that return true for the specified predicate.
int	detectIfNone(IntPredicate predicate, int ifNone)
void	each(IntProcedure procedure)	A synonym for forEach.
IntSet	freeze()	Returns a frozen copy of this set.
int	hashCode()	Follows the same general contract as Set.hashCode().
<T> T	injectInto(T injectedValue, ObjectIntToObjectFunction<? super T, ? extends T> function)
MutableIntIterator	intIterator()	Returns a primitive iterator that can be used to iterate over the IntIterable in an imperative style.
private static boolean	isBetweenZeroAndThirtyOne(int value)
private static boolean	isNonSentinel(int value)
private int	mask(int spread)
int	max()
private int	maxOccupiedWithData()
int	min()
IntHashSet	newEmpty()	Creates a new empty IntHashSet.
static IntHashSet	newSet(IntIterable source)
static IntHashSet	newSetWith(int... source)
(package private) int	probe(int element)
(package private) int	probeThree(int element, int removedIndex)
(package private) int	probeTwo(int element, int removedIndex)
void	readExternal(ObjectInput in)
private void	rehash(int newCapacity)
private void	rehashAndGrow()
IntHashSet	reject(IntPredicate predicate)	Returns a new IntIterable with all of the elements in the IntIterable that return false for the specified predicate.
<R extends MutableIntCollection> R	reject(IntPredicate predicate, R target)	Same as IntIterable.reject(IntPredicate) , only the results are added to the target MutableIntCollection.
boolean	remove(int value)
boolean	removeAll(int... source)
boolean	removeAll(IntIterable source)
private boolean	removeZeroToThirtyOne(int value)
boolean	retainAll(int... source)
boolean	retainAll(IntIterable source)
IntHashSet	select(IntPredicate predicate)	Returns a new IntIterable with all of the elements in the IntIterable that return true for the specified predicate.
<R extends MutableIntCollection> R	select(IntPredicate predicate, R target)	Same as IntIterable.select(IntPredicate) , only the results are added to the target MutableIntCollection.
int	size()	Returns the number of items in this iterable.
private int	smallestPowerOfTwoGreaterThan(int n)
(package private) int	spreadAndMask(int element)
(package private) int	spreadTwoAndMask(int element)
long	sum()
int[]	toArray()	Converts the IntIterable to a primitive int array.
int[]	toArray(int[] array)	Converts the IntIterable to a primitive int array.
ImmutableIntSet	toImmutable()	Returns an immutable copy of this set.
boolean	trimToSize()
IntHashSet	with(int element)
IntHashSet	withAll(IntIterable elements)
IntHashSet	without(int element)
IntHashSet	withoutAll(IntIterable elements)
void	writeExternal(ObjectOutput out)

Methods inherited from class AbstractIntSet

cartesianProduct, equals

Methods inherited from class AbstractIntIterable

asLazy, average, maxIfEmpty, median, minIfEmpty, toBag, toList, toSet, toSortedArray, toSortedList, toString

Methods inherited from class Object

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

Methods inherited from interface IntIterable

asLazy, average, averageIfEmpty, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, containsAll, containsAll, containsAny, containsAny, containsNone, containsNone, flatCollect, forEach, injectIntoBoolean, injectIntoByte, injectIntoChar, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, injectIntoShort, maxIfEmpty, median, medianIfEmpty, minIfEmpty, noneSatisfy, reduce, reduceIfEmpty, summaryStatistics, toBag, toList, toSet, toSortedArray, toSortedList, toSortedList, toSortedListBy, toSortedListBy

Methods inherited from interface IntSet

cartesianProduct, equals, isProperSubsetOf, isSubsetOf, tap

Methods inherited from interface MutableIntCollection

removeIf

Methods inherited from interface MutableIntSet

difference, intersect, symmetricDifference, tap, union

Methods inherited from interface PrimitiveIterable

appendString, appendString, isEmpty, makeString, makeString, makeString, notEmpty, toString

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

DEFAULT_INITIAL_CAPACITY

private static final int DEFAULT_INITIAL_CAPACITY

See Also:

• Constant Field Values

EMPTY

private static final int EMPTY

See Also:

• Constant Field Values

REMOVED

private static final int REMOVED

See Also:

• Constant Field Values

CACHE_LINE_SIZE

private static final int CACHE_LINE_SIZE

See Also:

• Constant Field Values

KEY_SIZE

private static final int KEY_SIZE

See Also:

• Constant Field Values

INITIAL_LINEAR_PROBE

private static final int INITIAL_LINEAR_PROBE

See Also:

• Constant Field Values

table

private int[] table

occupiedWithData

private int occupiedWithData

occupiedWithSentinels

private int occupiedWithSentinels

zeroToThirtyOne

private int zeroToThirtyOne

zeroToThirtyOneOccupied

private int zeroToThirtyOneOccupied

copyOnWrite

private transient boolean copyOnWrite

Constructor Details

IntHashSet

public IntHashSet()

IntHashSet

public IntHashSet(int initialCapacity)

IntHashSet

public IntHashSet(int... elements)

IntHashSet

public IntHashSet(IntIterable elements)

IntHashSet

public IntHashSet(IntHashSet set)

Method Details

boxed

public MutableSet<Integer> boxed()

Specified by:

boxed in interface MutableIntSet

smallestPowerOfTwoGreaterThan

private int smallestPowerOfTwoGreaterThan(int n)

newSet

public static IntHashSet newSet(IntIterable source)

newSetWith

public static IntHashSet newSetWith(int... source)

isBetweenZeroAndThirtyOne

private static boolean isBetweenZeroAndThirtyOne(int value)

hashCode

public int hashCode()

Description copied from interface: IntSet

Follows the same general contract as Set.hashCode().

Specified by:

hashCode in interface IntSet

Specified by:

hashCode in class AbstractIntSet

size

public int size()

Description copied from interface: PrimitiveIterable

Returns the number of items in this iterable.

Specified by:

size in interface PrimitiveIterable

appendString

public void appendString(Appendable appendable,
 String start,
 String separator,
 String end)

Description copied from interface: PrimitiveIterable

Prints a string representation of this collection onto the given Appendable. Prints the string returned by PrimitiveIterable.makeString(String, String, String).

Specified by:

appendString in interface PrimitiveIterable

add

public boolean add(int element)

Specified by:

add in interface MutableIntCollection

addAll

public boolean addAll(int... source)

Specified by:

addAll in interface MutableIntCollection

addAll

public boolean addAll(IntIterable source)

Specified by:

addAll in interface MutableIntCollection

remove

public boolean remove(int value)

Specified by:

remove in interface MutableIntCollection

removeZeroToThirtyOne

private boolean removeZeroToThirtyOne(int value)

removeAll

public boolean removeAll(IntIterable source)

Specified by:

removeAll in interface MutableIntCollection

removeAll

public boolean removeAll(int... source)

Specified by:

removeAll in interface MutableIntCollection

retainAll

public boolean retainAll(IntIterable source)

Specified by:

retainAll in interface MutableIntCollection

See Also:

• Collection.retainAll(Collection)

retainAll

public boolean retainAll(int... source)

Specified by:

retainAll in interface MutableIntCollection

See Also:

• Collection.retainAll(Collection)

clear

public void clear()

Specified by:

clear in interface MutableIntCollection

with

public IntHashSet with(int element)

Specified by:

with in interface MutableIntCollection

Specified by:

with in interface MutableIntSet

without

public IntHashSet without(int element)

Specified by:

without in interface MutableIntCollection

Specified by:

without in interface MutableIntSet

withAll

public IntHashSet withAll(IntIterable elements)

Specified by:

withAll in interface MutableIntCollection

Specified by:

withAll in interface MutableIntSet

withoutAll

public IntHashSet withoutAll(IntIterable elements)

Specified by:

withoutAll in interface MutableIntCollection

Specified by:

withoutAll in interface MutableIntSet

asUnmodifiable

public MutableIntSet asUnmodifiable()

Specified by:

asUnmodifiable in interface MutableIntCollection

Specified by:

asUnmodifiable in interface MutableIntSet

asSynchronized

public MutableIntSet asSynchronized()

Specified by:

asSynchronized in interface MutableIntCollection

Specified by:

asSynchronized in interface MutableIntSet

toImmutable

public ImmutableIntSet toImmutable()

Description copied from interface: IntSet

Returns an immutable copy of this set. If the set is immutable, it returns itself.

Specified by:

toImmutable in interface IntSet

Specified by:

toImmutable in interface MutableIntCollection

Specified by:

toImmutable in interface MutableIntSet

intIterator

public MutableIntIterator intIterator()

Description copied from interface: IntIterable

Returns a primitive iterator that can be used to iterate over the IntIterable in an imperative style.

Specified by:

intIterator in interface IntIterable

Specified by:

intIterator in interface MutableIntCollection

toArray

public int[] toArray()

Description copied from interface: IntIterable

Converts the IntIterable to a primitive int array.

Specified by:

toArray in interface IntIterable

toArray

public int[] toArray(int[] array)

Description copied from interface: IntIterable

Converts the IntIterable to a primitive int array. If the collection fits into the provided array it is used to store its elements and is returned from the method, otherwise a new array of the appropriate size is allocated and returned. If the iterable is empty, the target array is returned unchanged.

Specified by:

toArray in interface IntIterable

contains

public boolean contains(int value)

Description copied from interface: IntIterable

Returns true if the value is contained in the IntIterable, and false if it is not.

Specified by:

contains in interface IntIterable

each

public void each(IntProcedure procedure)

Description copied from interface: IntIterable

A synonym for forEach.

Specified by:

each in interface IntIterable

Since:

7.0.

select

public IntHashSet select(IntPredicate predicate)

Description copied from interface: IntIterable

Returns a new IntIterable with all of the elements in the IntIterable that return true for the specified predicate.

Specified by:

select in interface IntIterable

Specified by:

select in interface IntSet

Specified by:

select in interface MutableIntCollection

Specified by:

select in interface MutableIntSet

select

public <R extends MutableIntCollection> R select(IntPredicate predicate,
 R target)

Description copied from interface: IntIterable

Same as IntIterable.select(IntPredicate) , only the results are added to the target MutableIntCollection.

Specified by:

select in interface IntIterable

Since:

8.1.

reject

public IntHashSet reject(IntPredicate predicate)

Description copied from interface: IntIterable

Returns a new IntIterable with all of the elements in the IntIterable that return false for the specified predicate.

Specified by:

reject in interface IntIterable

Specified by:

reject in interface IntSet

Specified by:

reject in interface MutableIntCollection

Specified by:

reject in interface MutableIntSet

reject

public <R extends MutableIntCollection> R reject(IntPredicate predicate,
 R target)

Description copied from interface: IntIterable

Same as IntIterable.reject(IntPredicate) , only the results are added to the target MutableIntCollection.

Specified by:

reject in interface IntIterable

Since:

8.1.

collect

public <V> MutableSet<V> collect(IntToObjectFunction<? extends V> function)

Description copied from interface: IntIterable

Returns a new collection with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Specified by:

collect in interface IntIterable

Specified by:

collect in interface IntSet

Specified by:

collect in interface MutableIntCollection

Specified by:

collect in interface MutableIntSet

collect

public <V, R extends Collection<V>> R collect(IntToObjectFunction<? extends V> function,
 R target)

Description copied from interface: IntIterable

Same as IntIterable.collect(IntToObjectFunction) , only the results are added to the target Collection.

Specified by:

collect in interface IntIterable

Since:

8.1.

detectIfNone

public int detectIfNone(IntPredicate predicate,
 int ifNone)

Specified by:

detectIfNone in interface IntIterable

count

public int count(IntPredicate predicate)

Description copied from interface: IntIterable

Returns a count of the number of elements in the IntIterable that return true for the specified predicate.

Specified by:

count in interface IntIterable

anySatisfy

public boolean anySatisfy(IntPredicate predicate)

Description copied from interface: IntIterable

Returns true if any of the elements in the IntIterable return true for the specified predicate, otherwise returns false.

Specified by:

anySatisfy in interface IntIterable

allSatisfy

public boolean allSatisfy(IntPredicate predicate)

Description copied from interface: IntIterable

Returns true if all of the elements in the IntIterable return true for the specified predicate, otherwise returns false.

Specified by:

allSatisfy in interface IntIterable

sum

public long sum()

Specified by:

sum in interface IntIterable

max

public int max()

Specified by:

max in interface IntIterable

min

public int min()

Specified by:

min in interface IntIterable

freeze

public IntSet freeze()

Description copied from interface: IntSet

Returns a frozen copy of this set. If the set is frozen, it returns itself. A frozen copy is the same thing as an immutable copy without safe-publish guarantees.

Specified by:

freeze in interface IntSet

Specified by:

freeze in interface MutableIntSet

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

injectInto

public <T> T injectInto(T injectedValue,
 ObjectIntToObjectFunction<? super T, ? extends T> function)

Specified by:

injectInto in interface IntIterable

chunk

public RichIterable<IntIterable> chunk(int size)

Description copied from interface: IntIterable

Partitions elements in fixed size chunks.

Specified by:

chunk in interface IntIterable

Parameters:

size - the number of elements per chunk

Returns:

A RichIterable containing IntIterables of size size, except the last will be truncated if the elements don't divide evenly.

newEmpty

public IntHashSet newEmpty()

Creates a new empty IntHashSet.

Specified by:

newEmpty in interface MutableIntCollection

Specified by:

newEmpty in interface MutableIntSet

Since:

9.2.

trimToSize

public boolean trimToSize()

Since:

12.0

compact

@Deprecated
public void compact()

Deprecated.

since 12.0 - Use trimToSize() instead

Rehashes every element in the set into a new backing table of the smallest possible size and eliminating removed sentinels.

rehashAndGrow

private void rehashAndGrow()

rehash

private void rehash(int newCapacity)

allocateTable

protected void allocateTable(int sizeToAllocate)

probe

int probe(int element)

probeTwo

int probeTwo(int element,
 int removedIndex)

probeThree

int probeThree(int element,
 int removedIndex)

spreadAndMask

int spreadAndMask(int element)

spreadTwoAndMask

int spreadTwoAndMask(int element)

mask

private int mask(int spread)

copyTable

private void copyTable()

maxOccupiedWithData

private int maxOccupiedWithData()

isNonSentinel

private static boolean isNonSentinel(int value)