GNU Trove

gnu.trove.map.hash
Class TCharIntHashMap

java.lang.Object
  extended by gnu.trove.impl.hash.THash
      extended by gnu.trove.impl.hash.TPrimitiveHash
          extended by gnu.trove.impl.hash.TCharIntHash
              extended by gnu.trove.map.hash.TCharIntHashMap
All Implemented Interfaces:
TCharIntMap, java.io.Externalizable, java.io.Serializable

public class TCharIntHashMap
extends gnu.trove.impl.hash.TCharIntHash
implements TCharIntMap, java.io.Externalizable

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

See Also:
Serialized Form

Nested Class Summary
protected  class TCharIntHashMap.TKeyView
          a view onto the keys of the map.
protected  class TCharIntHashMap.TValueView
          a view onto the values of the map.
 
Field Summary
protected  int[] _values
          the values of the map
 
Fields inherited from class gnu.trove.impl.hash.TCharIntHash
_set, consumeFreeSlot, 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
TCharIntHashMap()
          Creates a new TCharIntHashMap instance with the default capacity and load factor.
TCharIntHashMap(char[] keys, int[] values)
          Creates a new TCharIntHashMap instance containing all of the entries in the map passed in.
TCharIntHashMap(int initialCapacity)
          Creates a new TCharIntHashMap instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.
TCharIntHashMap(int initialCapacity, float loadFactor)
          Creates a new TCharIntHashMap instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.
TCharIntHashMap(int initialCapacity, float loadFactor, char noEntryKey, int noEntryValue)
          Creates a new TCharIntHashMap instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.
TCharIntHashMap(TCharIntMap map)
          Creates a new TCharIntHashMap instance containing all of the entries in the map passed in.
 
Method Summary
 int adjustOrPutValue(char key, int adjust_amount, int put_amount)
          Adjusts the primitive value mapped to the key if the key is present in the map.
 boolean adjustValue(char key, int amount)
          Adjusts the primitive value mapped to key.
 void clear()
          Empties the collection.
 boolean containsKey(char key)
          Checks for the present of key in the keys of the map.
 boolean containsValue(int val)
          Checks for the presence of val in the values of the map.
 boolean equals(java.lang.Object other)
          
 boolean forEachEntry(TCharIntProcedure procedure)
          Executes procedure for each key/value entry in the map.
 boolean forEachKey(TCharProcedure procedure)
          Executes procedure for each key in the map.
 boolean forEachValue(TIntProcedure procedure)
          Executes procedure for each value in the map.
 int get(char key)
          Retrieves the value for key
 int hashCode()
          
 boolean increment(char key)
          Increments the primitive value mapped to key by 1
 boolean isEmpty()
          Tells whether this set is currently holding any elements.
 TCharIntIterator iterator()
          
 char[] keys()
          Returns the keys of the map as an array of char values.
 char[] keys(char[] array)
          Returns the keys of the map.
 TCharSet keySet()
          Returns the keys of the map as a TCharSet
 int put(char key, int value)
          Inserts a key/value pair into the map.
 void putAll(java.util.Map<? extends java.lang.Character,? extends java.lang.Integer> map)
          Put all the entries from the given Map into this map.
 void putAll(TCharIntMap map)
          Put all the entries from the given map into this map.
 int putIfAbsent(char key, int 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.
 int remove(char key)
          Deletes a key/value pair from the map.
protected  void removeAt(int index)
          Releases the element currently stored at index.
 boolean retainEntries(TCharIntProcedure 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(TIntFunction function)
          Transform the values in this map using function.
 TIntCollection valueCollection()
          Returns the values of the map as a TIntCollection
 int[] values()
          Returns the values of the map as an array of #e# values.
 int[] values(int[] 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.TCharIntHash
contains, forEach, getNoEntryKey, getNoEntryValue, index, insertKey, XinsertKey
 
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.TCharIntMap
getNoEntryKey, getNoEntryValue, size
 

Field Detail

_values

protected transient int[] _values
the values of the map

Constructor Detail

TCharIntHashMap

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


TCharIntHashMap

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

Parameters:
initialCapacity - an int value

TCharIntHashMap

public TCharIntHashMap(int initialCapacity,
                       float loadFactor)
Creates a new TCharIntHashMap 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

TCharIntHashMap

public TCharIntHashMap(int initialCapacity,
                       float loadFactor,
                       char noEntryKey,
                       int noEntryValue)
Creates a new TCharIntHashMap 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 char value that represents null for the Key set.
noEntryValue - a int value that represents null for the Value set.

TCharIntHashMap

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

Parameters:
keys - a char array containing the keys for the matching values.
values - a int array containing the values.

TCharIntHashMap

public TCharIntHashMap(TCharIntMap map)
Creates a new TCharIntHashMap instance containing all of the entries in the map passed in.

Parameters:
map - a TCharIntMap that will be duplicated.
Method Detail

setUp

protected int setUp(int initialCapacity)
initializes the hashtable to a prime capacity which is at least initialCapacity + 1.

Overrides:
setUp in class gnu.trove.impl.hash.TCharIntHash
Parameters:
initialCapacity - an int value
Returns:
the actual capacity chosen

rehash

protected void rehash(int newCapacity)
Rehashes the set.

Specified by:
rehash in class gnu.trove.impl.hash.THash
Parameters:
newCapacity - an int value

put

public int put(char key,
               int value)
Inserts a key/value pair into the map.

Specified by:
put in interface TCharIntMap
Parameters:
key - an char value
value - an int value
Returns:
the previous value associated with key, or the "no entry" value if none was found (see TCharIntMap.getNoEntryValue()).

putIfAbsent

public int putIfAbsent(char key,
                       int 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 TCharIntMap
Parameters:
key - an char value
value - an int value
Returns:
the previous value associated with key, or the "no entry" value if none was found (see TCharIntMap.getNoEntryValue()).

putAll

public void putAll(java.util.Map<? extends java.lang.Character,? extends java.lang.Integer> map)
Put all the entries from the given Map into this map.

Specified by:
putAll in interface TCharIntMap
Parameters:
map - The Map from which entries will be obtained to put into this map.

putAll

public void putAll(TCharIntMap map)
Put all the entries from the given map into this map.

Specified by:
putAll in interface TCharIntMap
Parameters:
map - The map from which entries will be obtained to put into this map.

get

public int get(char key)
Retrieves the value for key

Specified by:
get in interface TCharIntMap
Parameters:
key - an char value
Returns:
the previous value associated with key, or the "no entry" value if none was found (see TCharIntMap.getNoEntryValue()).

clear

public void clear()
Empties the collection.

Specified by:
clear in interface TCharIntMap
Overrides:
clear in class gnu.trove.impl.hash.THash

isEmpty

public boolean isEmpty()
Tells whether this set is currently holding any elements.

Specified by:
isEmpty in interface TCharIntMap
Overrides:
isEmpty in class gnu.trove.impl.hash.THash
Returns:
a boolean value

remove

public int remove(char key)
Deletes a key/value pair from the map.

Specified by:
remove in interface TCharIntMap
Parameters:
key - an char value
Returns:
the previous value associated with key, or the "no entry" value if none was found (see TCharIntMap.getNoEntryValue()).

removeAt

protected void removeAt(int index)
Releases the element currently stored at index.

Overrides:
removeAt in class gnu.trove.impl.hash.TCharIntHash
Parameters:
index - an int value

keySet

public TCharSet keySet()
Returns the keys of the map as a TCharSet

Specified by:
keySet in interface TCharIntMap
Returns:
the keys of the map as a TCharSet

keys

public char[] keys()
Returns the keys of the map as an array of char values.

Specified by:
keys in interface TCharIntMap
Returns:
the keys of the map as an array of char values.

keys

public char[] keys(char[] array)
Returns the keys of the map.

Specified by:
keys in interface TCharIntMap
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.

valueCollection

public TIntCollection valueCollection()
Returns the values of the map as a TIntCollection

Specified by:
valueCollection in interface TCharIntMap
Returns:
the values of the map as a TIntCollection

values

public int[] values()
Returns the values of the map as an array of #e# values.

Specified by:
values in interface TCharIntMap
Returns:
the values of the map as an array of #e# values.

values

public int[] values(int[] array)
Returns the values of the map using an existing array.

Specified by:
values in interface TCharIntMap
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.

containsValue

public boolean containsValue(int val)
Checks for the presence of val in the values of the map.

Specified by:
containsValue in interface TCharIntMap
Parameters:
val - an int value
Returns:
a boolean value

containsKey

public boolean containsKey(char key)
Checks for the present of key in the keys of the map.

Specified by:
containsKey in interface TCharIntMap
Parameters:
key - an char value
Returns:
a boolean value

iterator

public TCharIntIterator iterator()

Specified by:
iterator in interface TCharIntMap
Returns:
a TCharIntIterator with access to this map's keys and values

forEachKey

public boolean forEachKey(TCharProcedure procedure)
Executes procedure for each key in the map.

Specified by:
forEachKey in interface TCharIntMap
Parameters:
procedure - a TCharProcedure value
Returns:
false if the loop over the keys terminated because the procedure returned false for some key.

forEachValue

public boolean forEachValue(TIntProcedure procedure)
Executes procedure for each value in the map.

Specified by:
forEachValue in interface TCharIntMap
Parameters:
procedure - a T#F#Procedure value
Returns:
false if the loop over the values terminated because the procedure returned false for some value.

forEachEntry

public boolean forEachEntry(TCharIntProcedure procedure)
Executes procedure for each key/value entry in the map.

Specified by:
forEachEntry in interface TCharIntMap
Parameters:
procedure - a TOCharIntProcedure value
Returns:
false if the loop over the entries terminated because the procedure returned false for some entry.

transformValues

public void transformValues(TIntFunction function)
Transform the values in this map using function.

Specified by:
transformValues in interface TCharIntMap
Parameters:
function - a TIntFunction value

retainEntries

public boolean retainEntries(TCharIntProcedure procedure)
Retains only those entries in the map for which the procedure returns a true value.

Specified by:
retainEntries in interface TCharIntMap
Parameters:
procedure - determines which entries to keep
Returns:
true if the map was modified.

increment

public boolean increment(char key)
Increments the primitive value mapped to key by 1

Specified by:
increment in interface TCharIntMap
Parameters:
key - the key of the value to increment
Returns:
true if a mapping was found and modified.

adjustValue

public boolean adjustValue(char key,
                           int amount)
Adjusts the primitive value mapped to key.

Specified by:
adjustValue in interface TCharIntMap
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.

adjustOrPutValue

public int adjustOrPutValue(char key,
                            int adjust_amount,
                            int 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 TCharIntMap
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

equals

public boolean equals(java.lang.Object other)

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

writeExternal

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

Specified by:
writeExternal in interface java.io.Externalizable
Overrides:
writeExternal in class gnu.trove.impl.hash.TCharIntHash
Throws:
java.io.IOException

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 gnu.trove.impl.hash.TCharIntHash
Throws:
java.io.IOException
java.lang.ClassNotFoundException

GNU Trove