IntHashSet (Agrona)

java.lang.Object
- org.agrona.collections.IntHashSet

All Implemented Interfaces:

java.lang.Iterable<java.lang.Integer>, java.util.Collection<java.lang.Integer>, java.util.Set<java.lang.Integer>
```
public final class IntHashSet
extends java.lang.Object
implements java.util.Set<java.lang.Integer>
```
Open-addressing with linear-probing expandable hash set. Allocation free in steady state use when expanded.
By storing elements as int primitives this significantly reduces memory consumption compared with Java's builtin HashSet<Integer>. It implements Set<Integer> for convenience, but calling functionality via those methods can add boxing overhead to your usage.
Not Threadsafe.
This HashSet caches its iterator object, so nested iteration is not supported.

See Also:

IntIterator, Set

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_INITIAL_CAPACITY` The initial capacity used when none is specified in the constructor.
`static float`	`DEFAULT_LOAD_FACTOR` The load factor used when none is specified in the constructor.

Constructor Summary

Constructors
Constructor and Description
`IntHashSet(int missingValue)`
`IntHashSet(int proposedCapacity, int missingValue)`
`IntHashSet(int initialCapacity, int missingValue, float loadFactor)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(int value)` Primitive specialised overload of {this#add(Integer)}
`boolean`	`add(java.lang.Integer value)`
`boolean`	`addAll(java.util.Collection<? extends java.lang.Integer> coll)`
`int`	`capacity()` Get the total capacity for the set to which the load factor with be a fraction of.
`void`	`clear()`
`void`	`compact()` Compact the backing arrays by rehashing with a capacity just larger than current size and giving consideration to the load factor.
`boolean`	`contains(int value)`
`boolean`	`contains(java.lang.Object value)`
`boolean`	`containsAll(java.util.Collection<?> coll)`
`boolean`	`containsAll(IntHashSet other)` IntHashSet specialised variant of {this#containsAll(Collection)}.
`void`	`copy(IntHashSet that)`
`IntHashSet`	`difference(IntHashSet other)` Fast Path set difference for comparison with another IntHashSet.
`boolean`	`equals(java.lang.Object other)`
`int`	`hashCode()`
`boolean`	`isEmpty()`
`IntIterator`	`iterator()`
`float`	`loadFactor()` Get the load factor beyond which the set will increase size.
`int`	`missingValue()` The value to be used as a null marker in the set.
`boolean`	`remove(int value)` An int specialised version of {this#remove(Object)}.
`boolean`	`remove(java.lang.Object value)`
`boolean`	`removeAll(java.util.Collection<?> coll)`
`boolean`	`retainAll(java.util.Collection<?> coll)`
`int`	`size()`
`java.lang.Object[]`	`toArray()`
`<T> T[]`	`toArray(T[] into)`
`java.lang.String`	`toString()`

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

Methods inherited from interface java.util.Set
spliterator

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable
forEach

- Field Detail
  - DEFAULT_LOAD_FACTOR
```
public static final float DEFAULT_LOAD_FACTOR
```
    The load factor used when none is specified in the constructor.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_INITIAL_CAPACITY
```
public static final int DEFAULT_INITIAL_CAPACITY
```
    The initial capacity used when none is specified in the constructor.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - IntHashSet
```
public IntHashSet(int missingValue)
```
  - IntHashSet
```
public IntHashSet(int proposedCapacity,
                  int missingValue)
```
  - IntHashSet
```
public IntHashSet(int initialCapacity,
                  int missingValue,
                  float loadFactor)
```
- Method Detail
  - missingValue
```
public int missingValue()
```
    The value to be used as a null marker in the set.
    
    Returns:
    
    value to be used as a null marker in the set.
  - add
```
public boolean add(java.lang.Integer value)
```
    Specified by:
    
    add in interface java.util.Collection<java.lang.Integer>
    
    Specified by:
    
    add in interface java.util.Set<java.lang.Integer>
  - add
```
public boolean add(int value)
```
    Primitive specialised overload of {this#add(Integer)}
    
    Parameters:
    
    value - the value to add
    
    Returns:
    
    true if the collection has changed, false otherwise
  - remove
```
public boolean remove(java.lang.Object value)
```
    Specified by:
    
    remove in interface java.util.Collection<java.lang.Integer>
    
    Specified by:
    
    remove in interface java.util.Set<java.lang.Integer>
  - remove
```
public boolean remove(int value)
```
    An int specialised version of {this#remove(Object)}.
    
    Parameters:
    
    value - the value to remove
    
    Returns:
    
    true if the value was present, false otherwise
  - compact
```
public void compact()
```
    Compact the backing arrays by rehashing with a capacity just larger than current size and giving consideration to the load factor.
  - contains
```
public boolean contains(java.lang.Object value)
```
    Specified by:
    
    contains in interface java.util.Collection<java.lang.Integer>
    
    Specified by:
    
    contains in interface java.util.Set<java.lang.Integer>
  - contains
```
public boolean contains(int value)
```
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Collection<java.lang.Integer>
    
    Specified by:
    
    size in interface java.util.Set<java.lang.Integer>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface java.util.Collection<java.lang.Integer>
    
    Specified by:
    
    isEmpty in interface java.util.Set<java.lang.Integer>
  - loadFactor
```
public float loadFactor()
```
    Get the load factor beyond which the set will increase size.
    
    Returns:
    
    load factor for when the set should increase size.
  - capacity
```
public int capacity()
```
    Get the total capacity for the set to which the load factor with be a fraction of.
    
    Returns:
    
    the total capacity for the set.
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Collection<java.lang.Integer>
    
    Specified by:
    
    clear in interface java.util.Set<java.lang.Integer>
  - addAll
```
public boolean addAll(java.util.Collection<? extends java.lang.Integer> coll)
```
    Specified by:
    
    addAll in interface java.util.Collection<java.lang.Integer>
    
    Specified by:
    
    addAll in interface java.util.Set<java.lang.Integer>
  - containsAll
```
public boolean containsAll(java.util.Collection<?> coll)
```
    Specified by:
    
    containsAll in interface java.util.Collection<java.lang.Integer>
    
    Specified by:
    
    containsAll in interface java.util.Set<java.lang.Integer>
  - containsAll
```
public boolean containsAll(IntHashSet other)
```
    IntHashSet specialised variant of {this#containsAll(Collection)}.
    
    Parameters:
    
    other - int hash set to compare against.
    
    Returns:
    
    true if every element in other is in this.
  - difference
```
public IntHashSet difference(IntHashSet other)
```
    Fast Path set difference for comparison with another IntHashSet.
    NB: garbage free in the identical case, allocates otherwise.
    
    Parameters:
    
    other - the other set to subtract
    
    Returns:
    
    null if identical, otherwise the set of differences
  - removeAll
```
public boolean removeAll(java.util.Collection<?> coll)
```
    Specified by:
    
    removeAll in interface java.util.Collection<java.lang.Integer>
    
    Specified by:
    
    removeAll in interface java.util.Set<java.lang.Integer>
  - iterator
```
public IntIterator iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<java.lang.Integer>
    
    Specified by:
    
    iterator in interface java.util.Collection<java.lang.Integer>
    
    Specified by:
    
    iterator in interface java.util.Set<java.lang.Integer>
  - copy
```
public void copy(IntHashSet that)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - toArray
```
public <T> T[] toArray(T[] into)
```
    Specified by:
    
    toArray in interface java.util.Collection<java.lang.Integer>
    
    Specified by:
    
    toArray in interface java.util.Set<java.lang.Integer>
  - toArray
```
public java.lang.Object[] toArray()
```
    Specified by:
    
    toArray in interface java.util.Collection<java.lang.Integer>
    
    Specified by:
    
    toArray in interface java.util.Set<java.lang.Integer>
  - equals
```
public boolean equals(java.lang.Object other)
```
    Specified by:
    
    equals in interface java.util.Collection<java.lang.Integer>
    
    Specified by:
    
    equals in interface java.util.Set<java.lang.Integer>
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface java.util.Collection<java.lang.Integer>
    
    Specified by:
    
    hashCode in interface java.util.Set<java.lang.Integer>
    
    Overrides:
    
    hashCode in class java.lang.Object
  - retainAll
```
public boolean retainAll(java.util.Collection<?> coll)
```
    Specified by:
    
    retainAll in interface java.util.Collection<java.lang.Integer>
    
    Specified by:
    
    retainAll in interface java.util.Set<java.lang.Integer>

Class IntHashSet

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Set

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Field Detail

DEFAULT_LOAD_FACTOR

DEFAULT_INITIAL_CAPACITY

Constructor Detail

IntHashSet

IntHashSet

IntHashSet

Method Detail

missingValue

add

add

remove

remove

compact

contains

contains

size

isEmpty

loadFactor

capacity

clear

addAll

containsAll

containsAll

difference

removeAll

iterator

copy

toString

toArray

toArray

equals

hashCode

retainAll