com.badlogic.gdx.utils

Class IdentityMap<K,V>

java.lang.Object

com.badlogic.gdx.utils.IdentityMap<K,V>

All Implemented Interfaces:

Iterable<IdentityMap.Entry<K,V>>

public class IdentityMap<K,V>
extends Object
implements Iterable<IdentityMap.Entry<K,V>>

An unordered map that uses identity comparison for keys. This implementation is a cuckoo hash map using 3 hashes, random walking, and a small stash for problematic keys. Null keys are not allowed. Null values are allowed. No allocation is done except when growing the table size.

This map performs very fast get, containsKey, and remove (typically O(1), worst case O(log(n))). Put may be a bit slower, depending on hash collisions. Load factors greater than 0.91 greatly increase the chances the map will have to rehash to the next higher POT size.

Author:

Nathan Sweet

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IdentityMap.Entries<K,V>
static class	IdentityMap.Entry<K,V>
static class	IdentityMap.Keys<K>
static class	IdentityMap.Values<V>

Field Summary

Fields

Modifier and Type	Field and Description
int	size

Constructor Summary

Constructors

Constructor and Description
IdentityMap() Creates a new map with an initial capacity of 51 and a load factor of 0.8.
IdentityMap(IdentityMap map) Creates a new map identical to the specified map.
IdentityMap(int initialCapacity) Creates a new map with a load factor of 0.8.
IdentityMap(int initialCapacity, float loadFactor) Creates a new map with the specified initial capacity and load factor.

Method Summary

Modifier and Type	Method and Description
void	clear()
void	clear(int maximumCapacity) Clears the map and reduces the size of the backing arrays to be the specified capacity if they are larger.
boolean	containsKey(K key)
boolean	containsValue(Object value, boolean identity) Returns true if the specified value is in the map.
void	ensureCapacity(int additionalCapacity) Increases the size of the backing array to accommodate the specified number of additional items.
IdentityMap.Entries<K,V>	entries() Returns an iterator for the entries in the map.
boolean	equals(Object obj)
K	findKey(Object value, boolean identity) Returns the key for the specified value, or null if it is not in the map.
V	get(K key)
V	get(K key, V defaultValue)
int	hashCode()
boolean	isEmpty() Returns true if the map is empty.
Iterator<IdentityMap.Entry<K,V>>	iterator()
IdentityMap.Keys<K>	keys() Returns an iterator for the keys in the map.
V	put(K key, V value)
V	remove(K key)
void	shrink(int maximumCapacity) Reduces the size of the backing arrays to be the specified capacity or less.
String	toString()
IdentityMap.Values<V>	values() Returns an iterator for the values in the map.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

size

public int size

Constructor Detail

IdentityMap

public IdentityMap()

Creates a new map with an initial capacity of 51 and a load factor of 0.8.

IdentityMap

public IdentityMap(int initialCapacity)

Creates a new map with a load factor of 0.8.

Parameters:

initialCapacity - If not a power of two, it is increased to the next nearest power of two.

IdentityMap

public IdentityMap(int initialCapacity,
                   float loadFactor)

Creates a new map with the specified initial capacity and load factor. This map will hold initialCapacity items before growing the backing table.

Parameters:

initialCapacity - If not a power of two, it is increased to the next nearest power of two.

IdentityMap

public IdentityMap(IdentityMap map)

Creates a new map identical to the specified map.

Method Detail

put

public V put(K key,
             V value)

get

public V get(K key)

get

public V get(K key,
             V defaultValue)

remove

public V remove(K key)

isEmpty

public boolean isEmpty()

Returns true if the map is empty.

shrink

public void shrink(int maximumCapacity)

Reduces the size of the backing arrays to be the specified capacity or less. If the capacity is already less, nothing is done. If the map contains more items than the specified capacity, the next highest power of two capacity is used instead.

clear

public void clear(int maximumCapacity)

Clears the map and reduces the size of the backing arrays to be the specified capacity if they are larger.

clear

public void clear()

containsValue

public boolean containsValue(Object value,
                             boolean identity)

Returns true if the specified value is in the map. Note this traverses the entire map and compares every value, which may be an expensive operation.

Parameters:

identity - If true, uses == to compare the specified value with values in the map. If false, uses equals(Object).

containsKey

public boolean containsKey(K key)

findKey

public K findKey(Object value,
                 boolean identity)

Returns the key for the specified value, or null if it is not in the map. Note this traverses the entire map and compares every value, which may be an expensive operation.

Parameters:

identity - If true, uses == to compare the specified value with values in the map. If false, uses equals(Object).

ensureCapacity

public void ensureCapacity(int additionalCapacity)

Increases the size of the backing array to accommodate the specified number of additional items. Useful before adding many items to avoid multiple backing array resizes.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

iterator

public Iterator<IdentityMap.Entry<K,V>> iterator()

Specified by:

iterator in interface Iterable<IdentityMap.Entry<K,V>>

entries

public IdentityMap.Entries<K,V> entries()

Returns an iterator for the entries in the map. Remove is supported. Note that the same iterator instance is returned each time this method is called. Use the IdentityMap.Entries constructor for nested or multithreaded iteration.

values

public IdentityMap.Values<V> values()

Returns an iterator for the values in the map. Remove is supported. Note that the same iterator instance is returned each time this method is called. Use the IdentityMap.Entries constructor for nested or multithreaded iteration.

keys

public IdentityMap.Keys<K> keys()

Returns an iterator for the keys in the map. Remove is supported. Note that the same iterator instance is returned each time this method is called. Use the IdentityMap.Entries constructor for nested or multithreaded iteration.