CharHashSet (HPPC-RT v0.7.5 API Documentation)

java.lang.Object
- com.carrotsearch.hppcrt.AbstractCharCollection
- - com.carrotsearch.hppcrt.sets.CharHashSet

All Implemented Interfaces:

CharCollection, CharContainer, CharLookupContainer, CharSet, java.lang.Cloneable, java.lang.Iterable<CharCursor>
```
@Generated(date="2017-07-11T19:16:33+0200",
           value="KTypeHashSet.java")
public class CharHashSet
extends AbstractCharCollection
implements CharLookupContainer, CharSet, java.lang.Cloneable
```
A hash set of chars, 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 CharHashSet.EntryIterator
An iterator implementation for iterator().

Nested Classes
Modifier and Type	Class and Description
`class`	`CharHashSet.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<CharCursor,CharHashSet.EntryIterator>`	`entryIteratorPool` internal pool of EntryIterator
`char[]`	`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.AbstractCharCollection
containsNegateTestPredicate, containsTestPredicate, negatePredicate, testContainer, testPredicate

Constructor Summary

Constructors
Constructor and Description
`CharHashSet()` Default constructor: Creates a hash set with the default capacity of `Containers.DEFAULT_EXPECTED_ELEMENTS`, load factor of `HashContainers.DEFAULT_LOAD_FACTOR`.
`CharHashSet(CharContainer container)` Creates a hash set from elements of another container.
`CharHashSet(int initialCapacity)` Creates a hash set with the given capacity, load factor of `HashContainers.DEFAULT_LOAD_FACTOR`.
`CharHashSet(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(char... elements)` Vararg-signature method for adding elements to this set.
`boolean`	`add(char key)` Adds `k` to the set.
`int`	`add(char e1, char e2)` Adds two elements to the set.
`int`	`addAll(CharContainer container)` Adds all elements from a given container to this set.
`int`	`addAll(java.lang.Iterable<? extends CharCursor> 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.
`CharHashSet`	`clone()`
`boolean`	`contains(char key)` Lookup a given element in the container.
`boolean`	`equals(java.lang.Object obj)`
`<T extends CharPredicate> T`	`forEach(T predicate)` Applies a `predicate` to container elements, as long as the predicate returns `true`.
`<T extends CharProcedure> T`	`forEach(T procedure)` Applies a `procedure` to all container elements.
`static CharHashSet`	`from(char... elements)` Create a set from a variable number of arguments or an array of `char`.
`static CharHashSet`	`from(CharContainer container)` Create a set from elements of another container.
`int`	`hashCode()`
`CharHashSet.EntryIterator`	`iterator()` Returns an iterator to a cursor traversing the collection.
`static CharHashSet`	`newInstance()` Create a new hash set with default parameters (shortcut instead of using a constructor).
`static CharHashSet`	`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(char key)` Remove all elements of the set matching key.
`int`	`removeAll(char key)` Removes all occurrences of `e` from this collection.
`int`	`removeAll(CharPredicate 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.
`char[]`	`toArray(char[] 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.AbstractCharCollection
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.CharCollection
removeAll, retainAll, retainAll

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

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

- Field Detail
  - keys
```
public char[] 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<CharCursor,CharHashSet.EntryIterator> entryIteratorPool
```
    internal pool of EntryIterator
- Constructor Detail
  - CharHashSet
```
public CharHashSet()
```
    Default constructor: Creates a hash set with the default capacity of Containers.DEFAULT_EXPECTED_ELEMENTS, load factor of HashContainers.DEFAULT_LOAD_FACTOR.
  - CharHashSet
```
public CharHashSet(int initialCapacity)
```
    Creates a hash set with the given capacity, load factor of HashContainers.DEFAULT_LOAD_FACTOR.
  - CharHashSet
```
public CharHashSet(int initialCapacity,
                   double loadFactor)
```
    Creates a hash set with the given capacity and load factor.
  - CharHashSet
```
public CharHashSet(CharContainer container)
```
    Creates a hash set from elements of another container. Default load factor is used.
- Method Detail
  - add
```
public boolean add(char key)
```
    Adds k to the set.
    
    Specified by:
    
    add in interface CharSet
    
    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(char e1,
               char e2)
```
    Adds two elements to the set.
  - add
```
public int add(char... 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(CharContainer container)
```
    Adds all elements from a given container to this set.
    
    Specified by:
    
    addAll in interface CharSet
    
    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 CharCursor> iterable)
```
    Adds all elements from a given iterable to this set.
    
    Specified by:
    
    addAll in interface CharSet
    
    Returns:
    
    Returns the number of elements actually added as a result of this call (not previously present in the set).
  - removeAll
```
public int removeAll(char key)
```
    Removes all occurrences of e from this collection.
    
    Specified by:
    
    removeAll in interface CharCollection
    
    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(char 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 CharCollection.removeAll(key) > 0
    
    Specified by:
    
    remove in interface CharSet
    
    See Also:
    
    CharCollection.removeAll(char)
  - contains
```
public boolean contains(char 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 CharContainer
    
    Specified by:
    
    contains in interface CharLookupContainer
    
    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 CharCollection
  - 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 CharContainer
  - 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 CharContainer
  - 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 CharHashSet.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 (CharCursor<char> c : container) {
   System.out.println("index=" + c.index + " value=" + c.value);
 }
 
```
    Specified by:
    
    iterator in interface CharContainer
    
    Specified by:
    
    iterator in interface java.lang.Iterable<CharCursor>
  - forEach
```
public <T extends CharProcedure> T forEach(T procedure)
```
    Applies a procedure to all container elements. Returns the argument (any subclass of CharProcedure. 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 CharContainer
  - toArray
```
public char[] toArray(char[] target)
```
    Default implementation for: Copies all elements of this container to an existing array of the same type.
    
    Specified by:
    
    toArray in interface CharContainer
    
    Overrides:
    
    toArray in class AbstractCharCollection
    
    Parameters:
    
    target - The target array must be large enough to hold all elements, i.e >= CharContainer.size().
    
    Returns:
    
    Returns the target argument for chaining.
  - clone
```
public CharHashSet clone()
```
    Overrides:
    
    clone in class java.lang.Object
  - forEach
```
public <T extends CharPredicate> 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 CharContainer
  - removeAll
```
public int removeAll(CharPredicate predicate)
```
    Removes all elements in this collection for which the given predicate returns true.
    
    Specified by:
    
    removeAll in interface CharCollection
    
    Returns:
    
    Returns the number of removed elements.
  - from
```
public static CharHashSet from(char... elements)
```
    Create a set from a variable number of arguments or an array of char.
  - from
```
public static CharHashSet from(CharContainer container)
```
    Create a set from elements of another container.
  - newInstance
```
public static CharHashSet newInstance()
```
    Create a new hash set with default parameters (shortcut instead of using a constructor).
  - newInstance
```
public static CharHashSet 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 CharHashSet

Nested Class Summary

Field Summary

Fields inherited from class com.carrotsearch.hppcrt.AbstractCharCollection

Constructor Summary

Method Summary

Methods inherited from class com.carrotsearch.hppcrt.AbstractCharCollection

Methods inherited from class java.lang.Object

Methods inherited from interface com.carrotsearch.hppcrt.CharCollection

Methods inherited from interface com.carrotsearch.hppcrt.CharContainer

Methods inherited from interface java.lang.Iterable

Field Detail

keys

allocatedDefaultKey

assigned

loadFactor

entryIteratorPool

Constructor Detail

CharHashSet

CharHashSet

CharHashSet

CharHashSet

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