tl.lin.data.map
Class HMapKS<K>

java.lang.Object
  tl.lin.data.map.HMapKS<K>

Type Parameters:

K - the type of keys maintained by this map

All Implemented Interfaces:

Serializable, Cloneable, MapKS<K>

public class HMapKS<K>
extends Object
implements MapKS<K>, Cloneable, Serializable

Hash-based implementation of the MapKS interface. MapKS is a specialized variant the standard Java Map interface, except that the values are hard coded as floats for efficiency reasons (keys can be arbitrary objects). This implementation was adapted from HashMap version 1.73, 03/13/07. See this benchmark for an efficiency comparison.

See Also:

Serialized Form

Field Summary

Fields inherited from interface tl.lin.data.map.MapKS

DEFAULT_VALUE

Constructor Summary

HMapKS()
Constructs an empty HMapKS with the default initial capacity (1024) and the default load factor (0.75).

HMapKS(int initialCapacity)
Constructs an empty HMapKS with the specified initial capacity and the default load factor (0.75).

HMapKS(int initialCapacity, float loadFactor)
Constructs an empty HMapKS with the specified initial capacity and load factor.

HMapKS(MapKS<? extends K> m)
Constructs a new HMapKS with the same mappings as the specified MapKS.

Method Summary

void	clear() Removes all of the mappings from this map.
Object	clone() Returns a shallow copy of this HMapKS instance: the keys and values themselves are not cloned.
boolean	containsKey(K key) Returns true if this map contains a mapping for the specified key.
boolean	containsValue(short value) Returns true if this map contains one or more mappings with the specified value.
Set<MapKS.Entry<K>>	entrySet() Returns a Set view of the mappings contained in this map.
short	get(K key) Returns the value to which the specified key is mapped, or throws NoSuchElementException if this map contains no mapping for the key.
void	increment(K key) Increments the key.
void	increment(K key, short value) Increments the key by some value.
boolean	isEmpty() Returns true if this map contains no key-value mappings.
Set<K>	keySet() Returns a Set view of the keys contained in this map.
short	put(K key, short value) Associates the specified value with the specified key in this map.
void	putAll(MapKS<? extends K> m) Copies all of the mappings from the specified map to this map.
short	remove(K key) Removes the mapping for a key from this map if it is present.
int	size() Returns the number of key-value mappings in this map.
String	toString()
Collection<Short>	values() Returns a Collection view of the values contained in this map.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface tl.lin.data.map.MapKS

equals, hashCode

Constructor Detail

HMapKS

public HMapKS(int initialCapacity,
              float loadFactor)

Constructs an empty HMapKS with the specified initial capacity and load factor.

Parameters:

initialCapacity - the initial capacity

loadFactor - the load factor

Throws:

IllegalArgumentException - if the initial capacity is negative or the load factor is nonpositive

HMapKS

public HMapKS(int initialCapacity)

Constructs an empty HMapKS with the specified initial capacity and the default load factor (0.75).

Parameters:

initialCapacity - the initial capacity.

Throws:

IllegalArgumentException - if the initial capacity is negative.

HMapKS

public HMapKS()

Constructs an empty HMapKS with the default initial capacity (1024) and the default load factor (0.75).

HMapKS

public HMapKS(MapKS<? extends K> m)

Constructs a new HMapKS with the same mappings as the specified MapKS. The HMapKS is created with default load factor (0.75) and an initial capacity sufficient to hold the mappings in the specified MapKS.

Parameters:

m - the map whose mappings are to be placed in this map

Throws:

NullPointerException - if the specified map is null

Method Detail

size

public int size()

Description copied from interface: MapKS

Returns the number of key-value mappings in this map.

Specified by:

size in interface MapKS<K>

Returns:

the number of key-value mappings in this map

isEmpty

public boolean isEmpty()

Description copied from interface: MapKS

Returns true if this map contains no key-value mappings.

Specified by:

isEmpty in interface MapKS<K>

Returns:

true if this map contains no key-value mappings

get

public short get(K key)

Description copied from interface: MapKS

Returns the value to which the specified key is mapped, or throws NoSuchElementException if this map contains no mapping for the key.

Specified by:

get in interface MapKS<K>

Parameters:

key - the key whose associated value is to be returned

Returns:

the value to which the specified key is mapped

containsKey

public boolean containsKey(K key)

Description copied from interface: MapKS

Returns true if this map contains a mapping for the specified key.

Specified by:

containsKey in interface MapKS<K>

Parameters:

key - key whose presence in this map is to be tested

Returns:

true if this map contains a mapping for the specified key

put

public short put(K key,
                 short value)

Description copied from interface: MapKS

Associates the specified value with the specified key in this map. If the map previously contained a mapping for the key, the old value is replaced by the specified value.

Specified by:

put in interface MapKS<K>

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 of the key (or the default value, if none)

putAll

public void putAll(MapKS<? extends K> m)

Description copied from interface: MapKS

Copies all of the mappings from the specified map to this map.

Specified by:

putAll in interface MapKS<K>

Parameters:

m - mappings to be stored in this map

increment

public void increment(K key)

Increments the key. If the key does not exist in the map, its value is set to one.

Parameters:

key - key to increment

increment

public void increment(K key,
                      short value)

Increments the key by some value. If the key does not exist in the map, its value is set to the parameter value.

Parameters:

key - key to increment

value - increment value

remove

public short remove(K key)

Description copied from interface: MapKS

Removes the mapping for a key from this map if it is present. No action is performed if this map does not contain the key.

Specified by:

remove in interface MapKS<K>

Parameters:

key - key whose mapping is to be removed from the map

clear

public void clear()

Description copied from interface: MapKS

Removes all of the mappings from this map. The map will be empty after this call returns.

Specified by:

clear in interface MapKS<K>

containsValue

public boolean containsValue(short value)

Description copied from interface: MapKS

Returns true if this map contains one or more mappings with the specified value.

Specified by:

containsValue in interface MapKS<K>

Parameters:

value - value whose presence in this map is to be tested

Returns:

true this map contains one or more mappings with the specified value

clone

public Object clone()

Returns a shallow copy of this HMapKS instance: the keys and values themselves are not cloned.

Overrides:

clone in class Object

Returns:

a shallow copy of this map

keySet

public Set<K> keySet()

Description copied from interface: MapKS

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, and vice-versa.

Specified by:

keySet in interface MapKS<K>

Returns:

a set view of the keys contained in this map

values

public Collection<Short> values()

Description copied from interface: MapKS

Returns a Collection view of the values contained in this map. Note that this is a inefficient operation since it triggers autoboxing of the short values, which is exactly what this implementation is trying to avoid. Unlike a standard Java Map, values in the backing map cannot be altered with this collection view.

Specified by:

values in interface MapKS<K>

Returns:

a collection view of the values contained in this map

entrySet

public Set<MapKS.Entry<K>> entrySet()

Description copied from interface: MapKS

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, and vice-versa.

Specified by:

entrySet in interface MapKS<K>

Returns:

a set view of the mappings contained in this map

toString

public String toString()

Overrides:

toString in class Object