com.carrotsearch.hppcrt.maps

Class ObjectObjectIdentityHashMap<KType,VType>

java.lang.Object

com.carrotsearch.hppcrt.maps.ObjectObjectHashMap<KType,VType>

com.carrotsearch.hppcrt.maps.ObjectObjectIdentityHashMap<KType,VType>

All Implemented Interfaces:

ObjectObjectAssociativeContainer<KType,VType>, ObjectObjectMap<KType,VType>, java.lang.Cloneable, java.lang.Iterable<ObjectObjectCursor<KType,VType>>

@Generated(date="2017-07-11T19:16:32+0200",
           value="KTypeVTypeIdentityHashMap.java")
public class ObjectObjectIdentityHashMap<KType,VType>
extends ObjectObjectHashMap<KType,VType>

An identity hash map of Object to Object, implemented using open addressing with linear probing for collision resolution. The difference with ObjectObjectHashMap is that it uses direct Object reference equality for comparison and direct "address" System.identityHashCode(Object) for hashCode(), instead of using the built-in ObjectObjectHashMap.hashCode() / ObjectObjectHashMap.equals(Object).

This implementation supports null keys.

This implementation supports null values.

Nested Class Summary

Nested classes/interfaces inherited from class com.carrotsearch.hppcrt.maps.ObjectObjectHashMap

ObjectObjectHashMap.EntryIterator, ObjectObjectHashMap.KeysCollection, ObjectObjectHashMap.KeysIterator, ObjectObjectHashMap.ValuesCollection, ObjectObjectHashMap.ValuesIterator

Field Summary

Fields inherited from class com.carrotsearch.hppcrt.maps.ObjectObjectHashMap

allocatedDefaultKey, allocatedDefaultKeyValue, assigned, defaultValue, entryIteratorPool, hash_cache, keys, loadFactor, values

Constructor Summary

Constructors

Constructor and Description
ObjectObjectIdentityHashMap() Default constructor: Creates a hash map with the default capacity of Containers.DEFAULT_EXPECTED_ELEMENTS, load factor of HashContainers.DEFAULT_LOAD_FACTOR.
ObjectObjectIdentityHashMap(int initialCapacity) Creates a hash map with the given initial capacity, default load factor of HashContainers.DEFAULT_LOAD_FACTOR.
ObjectObjectIdentityHashMap(int initialCapacity, double loadFactor) Creates a hash map with the given initial capacity, load factor.
ObjectObjectIdentityHashMap(ObjectObjectAssociativeContainer<KType,VType> container) Create a hash map from all key-value pairs of another container.

Method Summary

Modifier and Type	Method and Description
ObjectObjectIdentityHashMap<KType,VType>	clone()
protected boolean	equalKeys(KType a, KType b) Equality customization to only consider object identity, comparing instances directly by ==.
static <KType,VType> ObjectObjectIdentityHashMap<KType,VType>	from(KType[] keys, VType[] values) Creates a hash map from two index-aligned arrays of key-value pairs.
static <KType,VType> ObjectObjectIdentityHashMap<KType,VType>	from(ObjectObjectAssociativeContainer<KType,VType> container) Create a hash map from another associative container.
protected int	hashKey(KType key) Hash customization to only consider the identity hash code.
static <KType,VType> ObjectObjectIdentityHashMap<KType,VType>	newInstance() Create a new hash map without providing the full generic signature (constructor shortcut).
static <KType,VType> ObjectObjectIdentityHashMap<KType,VType>	newInstance(int initialCapacity, double loadFactor) Create a new hash map with initial capacity and load factor control.

Methods inherited from class com.carrotsearch.hppcrt.maps.ObjectObjectHashMap

capacity, clear, containsKey, equals, forEach, forEach, get, getDefaultValue, hashCode, isEmpty, iterator, keys, put, putAll, putAll, putIfAbsent, remove, removeAll, removeAll, removeAll, setDefaultValue, size, toString, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ObjectObjectIdentityHashMap

public ObjectObjectIdentityHashMap()

Default constructor: Creates a hash map with the default capacity of Containers.DEFAULT_EXPECTED_ELEMENTS, load factor of HashContainers.DEFAULT_LOAD_FACTOR.

See class notes about hash distribution importance.

ObjectObjectIdentityHashMap

public ObjectObjectIdentityHashMap(int initialCapacity)

Creates a hash map with the given initial capacity, default load factor of HashContainers.DEFAULT_LOAD_FACTOR.

Parameters:

initialCapacity - Initial capacity (greater than zero and automatically rounded to the next power of two).

ObjectObjectIdentityHashMap

public ObjectObjectIdentityHashMap(int initialCapacity,
                                   double loadFactor)

Creates a hash map with the given initial capacity, load factor.

Parameters:

initialCapacity - Initial capacity (greater than zero and automatically rounded to the next power of two).

loadFactor - The load factor (greater than zero and smaller than 1).

ObjectObjectIdentityHashMap

public ObjectObjectIdentityHashMap(ObjectObjectAssociativeContainer<KType,VType> container)

Create a hash map from all key-value pairs of another container.

Method Detail

hashKey

protected int hashKey(KType key)

Hash customization to only consider the identity hash code.

Overrides:

hashKey in class ObjectObjectHashMap<KType,VType>

Parameters:

key - Object to be hashed.

Returns:

the hashed value of key, following the same semantic as ObjectObjectHashMap.hashCode();

See Also:

ObjectObjectHashMap.hashCode(), ObjectObjectHashMap.equalKeys(Object, Object)

equalKeys

protected boolean equalKeys(KType a,
                            KType b)

Equality customization to only consider object identity, comparing instances directly by ==.

Overrides:

equalKeys in class ObjectObjectHashMap<KType,VType>

Parameters:

a - not-null Object to be compared

b - not-null Object to be compared

Returns:

true if a and b are considered equal, following the same semantic as ObjectObjectHashMap.equals(Object).

See Also:

ObjectObjectHashMap.equals(Object), ObjectObjectHashMap.hashKey(Object)

clone

public ObjectObjectIdentityHashMap<KType,VType> clone()

Description copied from class: ObjectObjectHashMap

Overrides:

clone in class ObjectObjectHashMap<KType,VType>

from

public static <KType,VType> ObjectObjectIdentityHashMap<KType,VType> from(KType[] keys,
                                                                          VType[] values)

Creates a hash map from two index-aligned arrays of key-value pairs.

from

public static <KType,VType> ObjectObjectIdentityHashMap<KType,VType> from(ObjectObjectAssociativeContainer<KType,VType> container)

Create a hash map from another associative container.

newInstance

public static <KType,VType> ObjectObjectIdentityHashMap<KType,VType> newInstance()

Create a new hash map without providing the full generic signature (constructor shortcut).

newInstance

public static <KType,VType> ObjectObjectIdentityHashMap<KType,VType> newInstance(int initialCapacity,
                                                                                 double loadFactor)

Create a new hash map with initial capacity and load factor control. (constructor shortcut).