gnu.trove.map.hash
Class TIntCharHashMap

java.lang.Object
  gnu.trove.impl.hash.THash
      gnu.trove.impl.hash.TPrimitiveHash
          gnu.trove.impl.hash.TIntCharHash
              gnu.trove.map.hash.TIntCharHashMap

All Implemented Interfaces:

TIntCharMap, java.io.Externalizable, java.io.Serializable

public class TIntCharHashMap
extends TIntCharHash
implements TIntCharMap, java.io.Externalizable

An open addressed Map implementation for int keys and char values.

Version:

$Id: _K__V_HashMap.template,v 1.1.2.13 2009/11/16 21:25:13 robeden Exp $

Author:

Eric D. Friedman, Rob Eden, Jeff Randall

See Also:

Serialized Form

Nested Class Summary

protected class	TIntCharHashMap.TKeyView a view onto the keys of the map.
protected class	TIntCharHashMap.TValueView a view onto the values of the map.

Field Summary

protected char[]

_values the values of the map

Fields inherited from class gnu.trove.impl.hash.TIntCharHash

_set, no_entry_key, no_entry_value

Fields inherited from class gnu.trove.impl.hash.TPrimitiveHash

_states, FREE, FULL, REMOVED

Fields inherited from class gnu.trove.impl.hash.THash

_autoCompactionFactor, _autoCompactRemovesRemaining, _autoCompactTemporaryDisable, _free, _loadFactor, _maxSize, _size, DEFAULT_CAPACITY, DEFAULT_LOAD_FACTOR

Constructor Summary

TIntCharHashMap()
Creates a new TIntCharHashMap instance with the default capacity and load factor.

TIntCharHashMap(int initialCapacity)
Creates a new TIntCharHashMap instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.

TIntCharHashMap(int[] keys, char[] values)
Creates a new TIntCharHashMap instance containing all of the entries in the map passed in.

TIntCharHashMap(int initialCapacity, float loadFactor)
Creates a new TIntCharHashMap instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.

TIntCharHashMap(int initialCapacity, float loadFactor, int noEntryKey, char noEntryValue)
Creates a new TIntCharHashMap instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.

TIntCharHashMap(TIntCharMap map)
Creates a new TIntCharHashMap instance containing all of the entries in the map passed in.

Method Summary

char	adjustOrPutValue(int key, char adjust_amount, char put_amount) Adjusts the primitive value mapped to the key if the key is present in the map.
boolean	adjustValue(int key, char amount) Adjusts the primitive value mapped to key.
void	clear() Empties the collection.
boolean	containsKey(int key) Checks for the present of key in the keys of the map.
boolean	containsValue(char val) Checks for the presence of val in the values of the map.
boolean	equals(java.lang.Object other)
boolean	forEachEntry(TIntCharProcedure procedure) Executes procedure for each key/value entry in the map.
boolean	forEachKey(TIntProcedure procedure) Executes procedure for each key in the map.
boolean	forEachValue(TCharProcedure procedure) Executes procedure for each value in the map.
char	get(int key) Retrieves the value for key
int	hashCode()
boolean	increment(int key) Increments the primitive value mapped to key by 1
boolean	isEmpty() Tells whether this set is currently holding any elements.
TIntCharIterator	iterator()
int[]	keys() Returns the keys of the map as an array of int values.
int[]	keys(int[] array) Returns the keys of the map.
TIntSet	keySet() Returns the keys of the map as a TIntSet
char	put(int key, char value) Inserts a key/value pair into the map.
void	putAll(java.util.Map<? extends java.lang.Integer,? extends java.lang.Character> map) Put all the entries from the given Map into this map.
void	putAll(TIntCharMap map) Put all the entries from the given map into this map.
char	putIfAbsent(int key, char value) Inserts a key/value pair into the map if the specified key is not already associated with a value.
void	readExternal(java.io.ObjectInput in)
protected void	rehash(int newCapacity) Rehashes the set.
char	remove(int key) Deletes a key/value pair from the map.
protected void	removeAt(int index) Releases the element currently stored at index.
boolean	retainEntries(TIntCharProcedure procedure) Retains only those entries in the map for which the procedure returns a true value.
protected int	setUp(int initialCapacity) initializes the hashtable to a prime capacity which is at least initialCapacity + 1.
java.lang.String	toString()
void	transformValues(TCharFunction function) Transform the values in this map using function.
TCharCollection	valueCollection() Returns the values of the map as a TCharCollection
char[]	values() Returns the values of the map as an array of #e# values.
char[]	values(char[] array) Returns the values of the map using an existing array.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class gnu.trove.impl.hash.TIntCharHash

contains, forEach, getNoEntryKey, getNoEntryValue, index, insertionIndex

Methods inherited from class gnu.trove.impl.hash.TPrimitiveHash

capacity

Methods inherited from class gnu.trove.impl.hash.THash

calculateGrownCapacity, compact, computeMaxSize, computeNextAutoCompactionAmount, ensureCapacity, getAutoCompactionFactor, postInsertHook, reenableAutoCompaction, setAutoCompactionFactor, size, tempDisableAutoCompaction, trimToSize

Methods inherited from class java.lang.Object

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

Methods inherited from interface gnu.trove.map.TIntCharMap

getNoEntryKey, getNoEntryValue, size

Field Detail

_values

protected transient char[] _values

the values of the map

Constructor Detail

TIntCharHashMap

public TIntCharHashMap()

Creates a new TIntCharHashMap instance with the default capacity and load factor.

TIntCharHashMap

public TIntCharHashMap(int initialCapacity)

Creates a new TIntCharHashMap instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.

Parameters:

initialCapacity - an int value

TIntCharHashMap

public TIntCharHashMap(int initialCapacity,
                       float loadFactor)

Creates a new TIntCharHashMap instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.

Parameters:

initialCapacity - an int value

loadFactor - a float value

TIntCharHashMap

public TIntCharHashMap(int initialCapacity,
                       float loadFactor,
                       int noEntryKey,
                       char noEntryValue)

Creates a new TIntCharHashMap instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.

Parameters:

initialCapacity - an int value

loadFactor - a float value

noEntryKey - a int value that represents null for the Key set.

noEntryValue - a char value that represents null for the Value set.

TIntCharHashMap

public TIntCharHashMap(int[] keys,
                       char[] values)

Creates a new TIntCharHashMap instance containing all of the entries in the map passed in.

Parameters:

keys - a int array containing the keys for the matching values.

values - a char array containing the values.

TIntCharHashMap

public TIntCharHashMap(TIntCharMap map)

Creates a new TIntCharHashMap instance containing all of the entries in the map passed in.

Parameters:

map - a TIntCharMap that will be duplicated.

Method Detail

adjustOrPutValue

public char adjustOrPutValue(int key,
                             char adjust_amount,
                             char put_amount)

Adjusts the primitive value mapped to the key if the key is present in the map. Otherwise, the initial_value is put in the map.

Specified by:

adjustOrPutValue in interface TIntCharMap

Parameters:

key - the key of the value to increment

adjust_amount - the amount to adjust the value by

put_amount - the value put into the map if the key is not initial present

Returns:

the value present in the map after the adjustment or put operation

adjustValue

public boolean adjustValue(int key,
                           char amount)

Adjusts the primitive value mapped to key.

Specified by:

adjustValue in interface TIntCharMap

Parameters:

key - the key of the value to increment

amount - the amount to adjust the value by.

Returns:

true if a mapping was found and modified.

clear

public void clear()

Empties the collection.

Specified by:

clear in interface TIntCharMap

Overrides:

clear in class THash

containsKey

public boolean containsKey(int key)

Checks for the present of key in the keys of the map.

Specified by:

containsKey in interface TIntCharMap

Parameters:

key - an int value

Returns:

a boolean value

containsValue

public boolean containsValue(char val)

Checks for the presence of val in the values of the map.

Specified by:

containsValue in interface TIntCharMap

Parameters:

val - an char value

Returns:

a boolean value

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

forEachEntry

public boolean forEachEntry(TIntCharProcedure procedure)

Executes procedure for each key/value entry in the map.

Specified by:

forEachEntry in interface TIntCharMap

Parameters:

procedure - a TOIntCharProcedure value

Returns:

false if the loop over the entries terminated because the procedure returned false for some entry.

forEachKey

public boolean forEachKey(TIntProcedure procedure)

Executes procedure for each key in the map.

Specified by:

forEachKey in interface TIntCharMap

Parameters:

procedure - a TIntProcedure value

Returns:

false if the loop over the keys terminated because the procedure returned false for some key.

forEachValue

public boolean forEachValue(TCharProcedure procedure)

Executes procedure for each value in the map.

Specified by:

forEachValue in interface TIntCharMap

Parameters:

procedure - a T#F#Procedure value

Returns:

false if the loop over the values terminated because the procedure returned false for some value.

get

public char get(int key)

Retrieves the value for key

Specified by:

get in interface TIntCharMap

Parameters:

key - an int value

Returns:

the previous value associated with key, or the "no entry" value if none was found (see TIntCharMap.getNoEntryValue()).

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

increment

public boolean increment(int key)

Increments the primitive value mapped to key by 1

Specified by:

increment in interface TIntCharMap

Parameters:

key - the key of the value to increment

Returns:

true if a mapping was found and modified.

isEmpty

public boolean isEmpty()

Tells whether this set is currently holding any elements.

Specified by:

isEmpty in interface TIntCharMap

Overrides:

isEmpty in class THash

Returns:

a boolean value

iterator

public TIntCharIterator iterator()

Specified by:

iterator in interface TIntCharMap

Returns:

a TIntCharIterator with access to this map's keys and values

keys

public int[] keys()

Returns the keys of the map as an array of int values.

Specified by:

keys in interface TIntCharMap

Returns:

the keys of the map as an array of int values.

keys

public int[] keys(int[] array)

Returns the keys of the map.

Specified by:

keys in interface TIntCharMap

Parameters:

array - the array into which the elements of the list are to be stored, if it is big enough; otherwise, a new array of the same type is allocated for this purpose.

Returns:

the keys of the map as an array.

keySet

public TIntSet keySet()

Returns the keys of the map as a TIntSet

Specified by:

keySet in interface TIntCharMap

Returns:

the keys of the map as a TIntSet

put

public char put(int key,
                char value)

Inserts a key/value pair into the map.

Specified by:

put in interface TIntCharMap

Parameters:

key - an int value

value - an char value

Returns:

the previous value associated with key, or the "no entry" value if none was found (see TIntCharMap.getNoEntryValue()).

putAll

public void putAll(java.util.Map<? extends java.lang.Integer,? extends java.lang.Character> map)

Put all the entries from the given Map into this map.

Specified by:

putAll in interface TIntCharMap

Parameters:

map - The Map from which entries will be obtained to put into this map.

putAll

public void putAll(TIntCharMap map)

Put all the entries from the given map into this map.

Specified by:

putAll in interface TIntCharMap

Parameters:

map - The map from which entries will be obtained to put into this map.

putIfAbsent

public char putIfAbsent(int key,
                        char value)

Inserts a key/value pair into the map if the specified key is not already associated with a value.

Specified by:

putIfAbsent in interface TIntCharMap

Parameters:

key - an int value

value - an char value

Returns:

the previous value associated with key, or the "no entry" value if none was found (see TIntCharMap.getNoEntryValue()).

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Overrides:

readExternal in class TIntCharHash

Throws:

java.io.IOException

java.lang.ClassNotFoundException

rehash

protected void rehash(int newCapacity)

Rehashes the set.

Specified by:

rehash in class THash

Parameters:

newCapacity - an int value

remove

public char remove(int key)

Deletes a key/value pair from the map.

Specified by:

remove in interface TIntCharMap

Parameters:

key - an int value

Returns:

the previous value associated with key, or the "no entry" value if none was found (see TIntCharMap.getNoEntryValue()).

removeAt

protected void removeAt(int index)

Releases the element currently stored at index.

Overrides:

removeAt in class TIntCharHash

Parameters:

index - an int value

retainEntries

public boolean retainEntries(TIntCharProcedure procedure)

Retains only those entries in the map for which the procedure returns a true value.

Specified by:

retainEntries in interface TIntCharMap

Parameters:

procedure - determines which entries to keep

Returns:

true if the map was modified.

setUp

protected int setUp(int initialCapacity)

initializes the hashtable to a prime capacity which is at least initialCapacity + 1.

Overrides:

setUp in class TIntCharHash

Parameters:

initialCapacity - an int value

Returns:

the actual capacity chosen

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

transformValues

public void transformValues(TCharFunction function)

Transform the values in this map using function.

Specified by:

transformValues in interface TIntCharMap

Parameters:

function - a TCharFunction value

valueCollection

public TCharCollection valueCollection()

Returns the values of the map as a TCharCollection

Specified by:

valueCollection in interface TIntCharMap

Returns:

the values of the map as a TCharCollection

values

public char[] values()

Returns the values of the map as an array of #e# values.

Specified by:

values in interface TIntCharMap

Returns:

the values of the map as an array of #e# values.

values

public char[] values(char[] array)

Returns the values of the map using an existing array.

Specified by:

values in interface TIntCharMap

Parameters:

array - the array into which the elements of the list are to be stored, if it is big enough; otherwise, a new array of the same type is allocated for this purpose.

Returns:

the values of the map as an array of #e# values.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Overrides:

writeExternal in class TIntCharHash

Throws:

java.io.IOException