ByteHashSet (HPPC-RT v0.7.5 API Documentation)

java.lang.Object
- com.carrotsearch.hppcrt.AbstractByteCollection
- - com.carrotsearch.hppcrt.sets.ByteHashSet

All Implemented Interfaces:

ByteCollection, ByteContainer, ByteLookupContainer, ByteSet, java.lang.Cloneable, java.lang.Iterable<ByteCursor>
```
@Generated(date="2017-07-11T19:16:33+0200",
           value="KTypeHashSet.java")
public class ByteHashSet
extends AbstractByteCollection
implements ByteLookupContainer, ByteSet, java.lang.Cloneable
```
A hash set of bytes, implemented using using open addressing with linear probing for collision resolution.
The internal buffers of this implementation (keys, etc...) are always allocated to the nearest size that is a power of two. When the capacity exceeds the given load factor, the buffer size is doubled.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class ByteHashSet.EntryIterator
An iterator implementation for iterator().

Nested Classes
Modifier and Type	Class and Description
`class`	`ByteHashSet.EntryIterator` An iterator implementation for `iterator()`.

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`allocatedDefaultKey` True if key = 0/null is in the map.
`protected int`	`assigned` Cached number of assigned slots in `keys`.
`protected IteratorPool<ByteCursor,ByteHashSet.EntryIterator>`	`entryIteratorPool` internal pool of EntryIterator
`byte[]`	`keys` Hash-indexed array holding all set entries.
`protected double`	`loadFactor` The load factor for this map (fraction of allocated slots before the buffers must be rehashed or reallocated).

Fields inherited from class com.carrotsearch.hppcrt.AbstractByteCollection
containsNegateTestPredicate, containsTestPredicate, negatePredicate, testContainer, testPredicate

Constructor Summary

Constructors
Constructor and Description
`ByteHashSet()` Default constructor: Creates a hash set with the default capacity of `Containers.DEFAULT_EXPECTED_ELEMENTS`, load factor of `HashContainers.DEFAULT_LOAD_FACTOR`.
`ByteHashSet(ByteContainer container)` Creates a hash set from elements of another container.
`ByteHashSet(int initialCapacity)` Creates a hash set with the given capacity, load factor of `HashContainers.DEFAULT_LOAD_FACTOR`.
`ByteHashSet(int initialCapacity, double loadFactor)` Creates a hash set with the given capacity and load factor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`add(byte... elements)` Vararg-signature method for adding elements to this set.
`boolean`	`add(byte key)` Adds `k` to the set.
`int`	`add(byte e1, byte e2)` Adds two elements to the set.
`int`	`addAll(ByteContainer container)` Adds all elements from a given container to this set.
`int`	`addAll(java.lang.Iterable<? extends ByteCursor> iterable)` Adds all elements from a given iterable to this set.
`int`	`capacity()` Return the maximum number of elements this container is guaranteed to hold without reallocating.
`void`	`clear()` Removes all elements from this collection.
`ByteHashSet`	`clone()`
`boolean`	`contains(byte key)` Lookup a given element in the container.
`boolean`	`equals(java.lang.Object obj)`
`<T extends BytePredicate> T`	`forEach(T predicate)` Applies a `predicate` to container elements, as long as the predicate returns `true`.
`<T extends ByteProcedure> T`	`forEach(T procedure)` Applies a `procedure` to all container elements.
`static ByteHashSet`	`from(byte... elements)` Create a set from a variable number of arguments or an array of `byte`.
`static ByteHashSet`	`from(ByteContainer container)` Create a set from elements of another container.
`int`	`hashCode()`
`ByteHashSet.EntryIterator`	`iterator()` Returns an iterator to a cursor traversing the collection.
`static ByteHashSet`	`newInstance()` Create a new hash set with default parameters (shortcut instead of using a constructor).
`static ByteHashSet`	`newInstance(int initialCapacity, double loadFactor)` Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor).
`boolean`	`remove(byte key)` Remove all elements of the set matching key.
`int`	`removeAll(byte key)` Removes all occurrences of `e` from this collection.
`int`	`removeAll(BytePredicate predicate)` Removes all elements in this collection for which the given predicate returns `true`.
`int`	`size()` Return the current number of elements in this container.
`byte[]`	`toArray(byte[] target)` Default implementation for: Copies all elements of this container to an existing array of the same type.

Methods inherited from class com.carrotsearch.hppcrt.AbstractByteCollection
isEmpty, removeAll, retainAll, retainAll, toArray, toString

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

Methods inherited from interface com.carrotsearch.hppcrt.ByteCollection
removeAll, retainAll, retainAll

Methods inherited from interface com.carrotsearch.hppcrt.ByteContainer
isEmpty, toArray

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

- Field Detail
  - keys
```
public byte[] keys
```
    Hash-indexed array holding all set entries.
    Direct set iteration: iterate {keys[i]} for i in [0; keys.length[ where keys[i] != 0/null, then also {0/null} is in the set if allocatedDefaultKey = true.
  - allocatedDefaultKey
```
public boolean allocatedDefaultKey
```
    True if key = 0/null is in the map.
  - assigned
```
protected int assigned
```
    Cached number of assigned slots in keys.
  - loadFactor
```
protected final double loadFactor
```
    The load factor for this map (fraction of allocated slots before the buffers must be rehashed or reallocated).
  - entryIteratorPool
```
protected final IteratorPool<ByteCursor,ByteHashSet.EntryIterator> entryIteratorPool
```
    internal pool of EntryIterator
- Constructor Detail
  - ByteHashSet
```
public ByteHashSet()
```
    Default constructor: Creates a hash set with the default capacity of Containers.DEFAULT_EXPECTED_ELEMENTS, load factor of HashContainers.DEFAULT_LOAD_FACTOR.
  - ByteHashSet
```
public ByteHashSet(int initialCapacity)
```
    Creates a hash set with the given capacity, load factor of HashContainers.DEFAULT_LOAD_FACTOR.
  - ByteHashSet
```
public ByteHashSet(int initialCapacity,
                   double loadFactor)
```
    Creates a hash set with the given capacity and load factor.
  - ByteHashSet
```
public ByteHashSet(ByteContainer container)
```
    Creates a hash set from elements of another container. Default load factor is used.
- Method Detail
  - add
```
public boolean add(byte key)
```
    Adds k to the set.
    
    Specified by:
    
    add in interface ByteSet
    
    Returns:
    
    Returns true if this element was not part of the set before. Returns false if an equal element is already part of the set, and leaves the set unchanged. .
  - add
```
public int add(byte e1,
               byte e2)
```
    Adds two elements to the set.
  - add
```
public int add(byte... elements)
```
    Vararg-signature method for adding elements to this set.
    This method is handy, but costly if used in tight loops (anonymous array passing)
    
    Returns:
    
    Returns the number of elements that were added to the set (were not present in the set).
  - addAll
```
public int addAll(ByteContainer container)
```
    Adds all elements from a given container to this set.
    
    Specified by:
    
    addAll in interface ByteSet
    
    Returns:
    
    Returns the number of elements actually added as a result of this call (not previously present in the set).
  - addAll
```
public int addAll(java.lang.Iterable<? extends ByteCursor> iterable)
```
    Adds all elements from a given iterable to this set.
    
    Specified by:
    
    addAll in interface ByteSet
    
    Returns:
    
    Returns the number of elements actually added as a result of this call (not previously present in the set).
  - removeAll
```
public int removeAll(byte key)
```
    Removes all occurrences of e from this collection.
    
    Specified by:
    
    removeAll in interface ByteCollection
    
    Parameters:
    
    key - Element to be removed from this collection, if present.
    
    Returns:
    
    The number of removed elements as a result of this call.
  - remove
```
public boolean remove(byte key)
```
    Remove all elements of the set matching key. Returns true if key was present in the set and has been successfully removed. This is indeed an alias for ByteCollection.removeAll(key) > 0
    
    Specified by:
    
    remove in interface ByteSet
    
    See Also:
    
    ByteCollection.removeAll(byte)
  - contains
```
public boolean contains(byte key)
```
    Lookup a given element in the container. This operation has no speed guarantees (may be linear with respect to the size of this container).
    
    Specified by:
    
    contains in interface ByteContainer
    
    Specified by:
    
    contains in interface ByteLookupContainer
    
    Returns:
    
    Returns true if this container has an element equal to e.
  - clear
```
public void clear()
```
    Removes all elements from this collection.
    Does not release internal buffers.
    
    Specified by:
    
    clear in interface ByteCollection
  - size
```
public int size()
```
    Return the current number of elements in this container. The time for calculating the container's size may take O(n) time, although implementing classes should try to maintain the current size and return in constant time.
    
    Specified by:
    
    size in interface ByteContainer
  - capacity
```
public int capacity()
```
    Return the maximum number of elements this container is guaranteed to hold without reallocating. The time for calculating the container's capacity may take O(n) time.
    
    Specified by:
    
    capacity in interface ByteContainer
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - iterator
```
public ByteHashSet.EntryIterator iterator()
```
    Returns an iterator to a cursor traversing the collection. The order of traversal is not defined. More than one cursor may be active at a time. The behavior of iterators is undefined if structural changes are made to the underlying collection.
    The iterator is implemented as a cursor and it returns the same cursor instance on every call to Iterator.next() (to avoid boxing of primitive types). To read the current list's value (or index in the list) use the cursor's public fields. An example is shown below.
```
 for (ByteCursor<byte> c : container) {
   System.out.println("index=" + c.index + " value=" + c.value);
 }
 
```
    Specified by:
    
    iterator in interface ByteContainer
    
    Specified by:
    
    iterator in interface java.lang.Iterable<ByteCursor>
  - forEach
```
public <T extends ByteProcedure> T forEach(T procedure)
```
    Applies a procedure to all container elements. Returns the argument (any subclass of ByteProcedure. This lets the caller to call methods of the argument by chaining the call (even if the argument is an anonymous type) to retrieve computed values, for example (IntContainer):
```
 int count = container.forEach(new IntProcedure() {
      int count; // this is a field declaration in an anonymous class.
      public void apply(int value) { count++; }}).count;
 
```
    Specified by:
    
    forEach in interface ByteContainer
  - toArray
```
public byte[] toArray(byte[] target)
```
    Default implementation for: Copies all elements of this container to an existing array of the same type.
    
    Specified by:
    
    toArray in interface ByteContainer
    
    Overrides:
    
    toArray in class AbstractByteCollection
    
    Parameters:
    
    target - The target array must be large enough to hold all elements, i.e >= ByteContainer.size().
    
    Returns:
    
    Returns the target argument for chaining.
  - clone
```
public ByteHashSet clone()
```
    Overrides:
    
    clone in class java.lang.Object
  - forEach
```
public <T extends BytePredicate> T forEach(T predicate)
```
    Applies a predicate to container elements, as long as the predicate returns true. The iteration is interrupted otherwise.
    
    Specified by:
    
    forEach in interface ByteContainer
  - removeAll
```
public int removeAll(BytePredicate predicate)
```
    Removes all elements in this collection for which the given predicate returns true.
    
    Specified by:
    
    removeAll in interface ByteCollection
    
    Returns:
    
    Returns the number of removed elements.
  - from
```
public static ByteHashSet from(byte... elements)
```
    Create a set from a variable number of arguments or an array of byte.
  - from
```
public static ByteHashSet from(ByteContainer container)
```
    Create a set from elements of another container.
  - newInstance
```
public static ByteHashSet newInstance()
```
    Create a new hash set with default parameters (shortcut instead of using a constructor).
  - newInstance
```
public static ByteHashSet newInstance(int initialCapacity,
                                      double loadFactor)
```
    Returns a new object of this class with no need to declare generic type (shortcut instead of using a constructor).

Class ByteHashSet

Nested Class Summary

Field Summary

Fields inherited from class com.carrotsearch.hppcrt.AbstractByteCollection

Constructor Summary

Method Summary

Methods inherited from class com.carrotsearch.hppcrt.AbstractByteCollection

Methods inherited from class java.lang.Object

Methods inherited from interface com.carrotsearch.hppcrt.ByteCollection

Methods inherited from interface com.carrotsearch.hppcrt.ByteContainer

Methods inherited from interface java.lang.Iterable

Field Detail

keys

allocatedDefaultKey

assigned

loadFactor

entryIteratorPool

Constructor Detail

ByteHashSet

ByteHashSet

ByteHashSet

ByteHashSet

Method Detail

add

add

add

addAll

addAll

removeAll

remove

contains

clear

size

capacity

hashCode

equals

iterator

forEach

toArray

clone

forEach

removeAll

from

from

newInstance

newInstance