RadixHamTrie (bikey 0.9.0 API)

java.lang.Object
- com.jerolba.bikey.RadixHamTrie<V>

Type Parameters:

V - Type of the associated element

All Implemented Interfaces:

IntKeyMap<V>, java.lang.Cloneable, java.lang.Iterable<IntObjectEntry<V>>
```
public class RadixHamTrie<V>
extends java.lang.Object
implements IntKeyMap<V>, java.lang.Cloneable
```
Implements a radix hash array mapped trie data structure, with radix=32
The key is a primitive int and allows all range of integer values.
The data structure is optimal when keys are grouped around a limited range of values with low dispersion. The map is designed to store values associated to a set of bounded int keys.
Can be used as a map with integers as key (Map<Integer, T>) or a compact unbounded integer array (Integer[T])
The implementation uses a Radix HAMT over int keys. Each node of the HAMT has 5 bits.
Iteration over its elements is done in preorder and it is sorted in ascending.

Constructor Summary

Constructors
Constructor and Description
`RadixHamTrie()` Constructs an empty `RadixHamTrie`
`RadixHamTrie(IntKeyMap<? extends V> m)` Constructs a new `RadixHamTrie` with the same mappings as the specified `IntKeyMap`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Removes all of the elements from this map.
`java.lang.Object`	`clone()` Returns a shallow copy of this `RadixHamTrie` instance: the elements themselves are not cloned.
`boolean`	`containsValue(java.lang.Object value)` Returns `true` if this map maps one or more keys to the specified value.
`java.util.Set<IntObjectEntry<V>>`	`entrySet()` Returns a `Set` view of the mappings contained in this map.
`boolean`	`equals(java.lang.Object o)`
`void`	`forEach(java.util.function.Consumer<? super IntObjectEntry<V>> action)`
`void`	`forEach(IntObjectConsumer<V> action)` Performs the given action for each pair of element of the map until all elements have been processed or the action throws an exception.
`void`	`forEachKey(java.util.function.IntConsumer action)` Performs the given action to each int key element of the map until all elements have been processed or the action throws an exception.
`V`	`get(int key)` Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key.
`int`	`hashCode()`
`java.util.Iterator<IntObjectEntry<V>>`	`iterator()`
`java.util.Set<java.lang.Integer>`	`keySet()` Returns a `Set` view of the keys contained in this map.
`V`	`put(int key, V value)` Associates the specified value with the specified key in this int keyed map If the map previously contained a mapping for the key, the old value is replaced by the specified value.
`V`	`remove(int key)` Removes the specified element from this map if it is present.
`int`	`size()` Returns the number of elements in this map (its cardinality).
`java.util.Spliterator<IntObjectEntry<V>>`	`spliterator()`
`java.lang.String`	`toString()`
`java.util.Collection<V>`	`values()` Returns a `Collection` view of the values contained in this map.

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

Methods inherited from interface com.jerolba.bikey.IntKeyMap
compute, computeIfAbsent, computeIfPresent, containsKey, getOrDefault, isEmpty, merge, putAll, putIfAbsent, remove, replace, replace, stream

- Constructor Detail
  - RadixHamTrie
```
public RadixHamTrie()
```
    Constructs an empty RadixHamTrie
  - RadixHamTrie
```
public RadixHamTrie(IntKeyMap<? extends V> m)
```
    Constructs a new RadixHamTrie with the same mappings as the specified IntKeyMap.
    
    Parameters:
    
    m - the map whose mappings are to be placed in this map
    
    Throws:
    
    java.lang.NullPointerException - if the specified map is null
- Method Detail
  - put
```
public V put(int key,
             V value)
```
    Description copied from interface: IntKeyMap
    
    Associates the specified value with the specified key in this int keyed map If the map previously contained a mapping for the key, the old value is replaced by the specified value. (A map m is said to contain a mapping for a key k if and only if m.containsKey(k) would return true.)
    
    Specified by:
    
    put in interface IntKeyMap<V>
    
    Parameters:
    
    key - key with which the specified value is to be associated
    
    value - value to be associated with the specified key
    
    Returns:
    
    the previous value associated with key, or null if there was no mapping for key.
  - get
```
public V get(int key)
```
    Description copied from interface: IntKeyMap
    
    Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.
    
    Specified by:
    
    get in interface IntKeyMap<V>
    
    Parameters:
    
    key - the key whose associated value is to be returned
    
    Returns:
    
    the value to which the specified key is mapped, or null if this map contains no mapping for the key
  - remove
```
public V remove(int key)
```
    Description copied from interface: IntKeyMap
    
    Removes the specified element from this map if it is present.
    
    Specified by:
    
    remove in interface IntKeyMap<V>
    
    Parameters:
    
    key - the key to remove
    
    Returns:
    
    the previous value associated with key, or null if there was no mapping for key.
  - forEachKey
```
public void forEachKey(java.util.function.IntConsumer action)
```
    Description copied from interface: IntKeyMap
    
    Performs the given action to each int key element of the map until all elements have been processed or the action throws an exception. Exceptions thrown by the action are relayed to the caller.
    
    Specified by:
    
    forEachKey in interface IntKeyMap<V>
    
    Parameters:
    
    action - The action to be performed for each int key element
  - containsValue
```
public boolean containsValue(java.lang.Object value)
```
    Description copied from interface: IntKeyMap
    
    Returns true if this map maps one or more keys to the specified value.
    
    Specified by:
    
    containsValue in interface IntKeyMap<V>
    
    Parameters:
    
    value - value whose presence in this map is to be tested
    
    Returns:
    
    true if this map maps one or more keys to the specified value
  - size
```
public int size()
```
    Description copied from interface: IntKeyMap
    
    Returns the number of elements in this map (its cardinality).
    
    Specified by:
    
    size in interface IntKeyMap<V>
    
    Returns:
    
    the number of elements in this map
  - clear
```
public void clear()
```
    Description copied from interface: IntKeyMap
    
    Removes all of the elements from this map. The map will be empty after this call returns.
    
    Specified by:
    
    clear in interface IntKeyMap<V>
  - clone
```
public java.lang.Object clone()
```
    Returns a shallow copy of this RadixHamTrie instance: the elements themselves are not cloned.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    a shallow copy of this map
  - forEach
```
public void forEach(IntObjectConsumer<V> action)
```
    Description copied from interface: IntKeyMap
    
    Performs the given action for each pair of element of the map until all elements have been processed or the action throws an exception. Exceptions thrown by the action are relayed to the caller.
    
    Specified by:
    
    forEach in interface IntKeyMap<V>
    
    Parameters:
    
    action - The action to be performed for each pair of elements
  - forEach
```
public void forEach(java.util.function.Consumer<? super IntObjectEntry<V>> action)
```
    Specified by:
    
    forEach in interface java.lang.Iterable<IntObjectEntry<V>>
  - iterator
```
public java.util.Iterator<IntObjectEntry<V>> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<IntObjectEntry<V>>
  - spliterator
```
public java.util.Spliterator<IntObjectEntry<V>> spliterator()
```
    Specified by:
    
    spliterator in interface IntKeyMap<V>
    
    Specified by:
    
    spliterator in interface java.lang.Iterable<IntObjectEntry<V>>
  - values
```
public java.util.Collection<V> values()
```
    Description copied from interface: IntKeyMap
    
    Returns a Collection view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection. If the map is modified while an iteration over the collection is in progress, the results of the iteration are undefined. The collection doesn't support element removal.
    
    Specified by:
    
    values in interface IntKeyMap<V>
    
    Returns:
    
    a collection view of the values contained in this map
  - keySet
```
public java.util.Set<java.lang.Integer> keySet()
```
    Description copied from interface: IntKeyMap
    
    Returns a Set view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set. If the map is modified while an iteration over the set is in progress the results of the iteration are undefined. The set doesn't support element removal.
    
    Specified by:
    
    keySet in interface IntKeyMap<V>
    
    Returns:
    
    a set view of the mappings contained in this map
  - entrySet
```
public java.util.Set<IntObjectEntry<V>> entrySet()
```
    Description copied from interface: IntKeyMap
    
    Returns a Set view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set. If the map is modified while an iteration over the set is in progress the results of the iteration are undefined.
    
    Specified by:
    
    entrySet in interface IntKeyMap<V>
    
    Returns:
    
    a set view of the mappings contained in this map
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class RadixHamTrie<V>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.jerolba.bikey.IntKeyMap

Constructor Detail

RadixHamTrie

RadixHamTrie

Method Detail

put

get

remove

forEachKey

containsValue

size

clear

clone

forEach

forEach

iterator

spliterator

values

keySet

entrySet

equals

hashCode

toString