Package gnu.trove.map.hash
Class TLongCharHashMap
- java.lang.Object
-
- gnu.trove.impl.hash.THash
-
- gnu.trove.impl.hash.TPrimitiveHash
-
- gnu.trove.impl.hash.TLongCharHash
-
- gnu.trove.map.hash.TLongCharHashMap
-
- All Implemented Interfaces:
TLongCharMap
,java.io.Externalizable
,java.io.Serializable
public class TLongCharHashMap extends TLongCharHash implements TLongCharMap, java.io.Externalizable
An open addressed Map implementation for long keys and char values.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected class
TLongCharHashMap.TKeyView
a view onto the keys of the map.protected class
TLongCharHashMap.TValueView
a view onto the values of the map.
-
Field Summary
Fields Modifier and Type Field Description protected char[]
_values
the values of the map-
Fields inherited from class gnu.trove.impl.hash.TLongCharHash
_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
Constructors Constructor Description TLongCharHashMap()
Creates a newTLongCharHashMap
instance with the default capacity and load factor.TLongCharHashMap(int initialCapacity)
Creates a newTLongCharHashMap
instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.TLongCharHashMap(int initialCapacity, float loadFactor)
Creates a newTLongCharHashMap
instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.TLongCharHashMap(int initialCapacity, float loadFactor, long noEntryKey, char noEntryValue)
Creates a newTLongCharHashMap
instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.TLongCharHashMap(long[] keys, char[] values)
Creates a newTLongCharHashMap
instance containing all of the entries in the map passed in.TLongCharHashMap(TLongCharMap map)
Creates a newTLongCharHashMap
instance containing all of the entries in the map passed in.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description char
adjustOrPutValue(long 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(long key, char amount)
Adjusts the primitive value mapped to key.void
clear()
Empties the collection.boolean
containsKey(long 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(TLongCharProcedure procedure)
Executes procedure for each key/value entry in the map.boolean
forEachKey(TLongProcedure procedure)
Executes procedure for each key in the map.boolean
forEachValue(TCharProcedure procedure)
Executes procedure for each value in the map.char
get(long key)
Retrieves the value for key.int
hashCode()
boolean
increment(long key)
Increments the primitive value mapped to key by 1boolean
isEmpty()
Tells whether this set is currently holding any elements.TLongCharIterator
iterator()
long[]
keys()
Returns the keys of the map as an array of long values.long[]
keys(long[] array)
Returns the keys of the map.TLongSet
keySet()
Returns the keys of the map as a TLongSetchar
put(long key, char value)
Inserts a key/value pair into the map.void
putAll(TLongCharMap map)
Put all the entries from the given map into this map.void
putAll(java.util.Map<? extends java.lang.Long,? extends java.lang.Character> map)
Put all the entries from the given Map into this map.char
putIfAbsent(long 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(long key)
Deletes a key/value pair from the map.protected void
removeAt(int index)
Releases the element currently stored at index.boolean
retainEntries(TLongCharProcedure 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 TCharCollectionchar[]
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.TLongCharHash
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, fastCeil, getAutoCompactionFactor, postInsertHook, reenableAutoCompaction, saturatedCast, 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.TLongCharMap
getNoEntryKey, getNoEntryValue, size
-
-
-
-
Constructor Detail
-
TLongCharHashMap
public TLongCharHashMap()
Creates a newTLongCharHashMap
instance with the default capacity and load factor.
-
TLongCharHashMap
public TLongCharHashMap(int initialCapacity)
Creates a newTLongCharHashMap
instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.- Parameters:
initialCapacity
- anint
value
-
TLongCharHashMap
public TLongCharHashMap(int initialCapacity, float loadFactor)
Creates a newTLongCharHashMap
instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.- Parameters:
initialCapacity
- anint
valueloadFactor
- afloat
value
-
TLongCharHashMap
public TLongCharHashMap(int initialCapacity, float loadFactor, long noEntryKey, char noEntryValue)
Creates a newTLongCharHashMap
instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.- Parameters:
initialCapacity
- anint
valueloadFactor
- afloat
valuenoEntryKey
- along
value that represents null for the Key set.noEntryValue
- achar
value that represents null for the Value set.
-
TLongCharHashMap
public TLongCharHashMap(long[] keys, char[] values)
Creates a newTLongCharHashMap
instance containing all of the entries in the map passed in.- Parameters:
keys
- a long array containing the keys for the matching values.values
- a char array containing the values.
-
TLongCharHashMap
public TLongCharHashMap(TLongCharMap map)
Creates a newTLongCharHashMap
instance containing all of the entries in the map passed in.- Parameters:
map
- a TLongCharMap 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 classTLongCharHash
- Parameters:
initialCapacity
- anint
value- Returns:
- the actual capacity chosen
-
rehash
protected void rehash(int newCapacity)
Rehashes the set.
-
put
public char put(long key, char value)
Inserts a key/value pair into the map.- Specified by:
put
in interfaceTLongCharMap
- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TLongCharMap.getNoEntryValue()
).
-
putIfAbsent
public char putIfAbsent(long 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 interfaceTLongCharMap
- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TLongCharMap.getNoEntryValue()
).
-
putAll
public void putAll(java.util.Map<? extends java.lang.Long,? extends java.lang.Character> map)
Put all the entries from the given Map into this map.- Specified by:
putAll
in interfaceTLongCharMap
- Parameters:
map
- The Map from which entries will be obtained to put into this map.
-
putAll
public void putAll(TLongCharMap map)
Put all the entries from the given map into this map.- Specified by:
putAll
in interfaceTLongCharMap
- Parameters:
map
- The map from which entries will be obtained to put into this map.
-
get
public char get(long key)
Retrieves the value for key.- Specified by:
get
in interfaceTLongCharMap
- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TLongCharMap.getNoEntryValue()
).
-
clear
public void clear()
Empties the collection.- Specified by:
clear
in interfaceTLongCharMap
- Overrides:
clear
in classTHash
-
isEmpty
public boolean isEmpty()
Tells whether this set is currently holding any elements.- Specified by:
isEmpty
in interfaceTLongCharMap
- Overrides:
isEmpty
in classTHash
- Returns:
- a
boolean
value
-
remove
public char remove(long key)
Deletes a key/value pair from the map.- Specified by:
remove
in interfaceTLongCharMap
- Parameters:
key
- anlong
value- Returns:
- the previous value associated with key, or the "no entry" value
if none was found (see
TLongCharMap.getNoEntryValue()
).
-
removeAt
protected void removeAt(int index)
Releases the element currently stored at index.- Overrides:
removeAt
in classTLongCharHash
- Parameters:
index
- anint
value
-
keySet
public TLongSet keySet()
Returns the keys of the map as a TLongSet- Specified by:
keySet
in interfaceTLongCharMap
- Returns:
- the keys of the map as a TLongSet
-
keys
public long[] keys()
Returns the keys of the map as an array of long values.- Specified by:
keys
in interfaceTLongCharMap
- Returns:
- the keys of the map as an array of long values.
-
keys
public long[] keys(long[] array)
Returns the keys of the map.- Specified by:
keys
in interfaceTLongCharMap
- 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 TCharCollection valueCollection()
Returns the values of the map as a TCharCollection- Specified by:
valueCollection
in interfaceTLongCharMap
- 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 interfaceTLongCharMap
- 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 interfaceTLongCharMap
- 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(char val)
Checks for the presence of val in the values of the map.- Specified by:
containsValue
in interfaceTLongCharMap
-
containsKey
public boolean containsKey(long key)
Checks for the present of key in the keys of the map.- Specified by:
containsKey
in interfaceTLongCharMap
-
iterator
public TLongCharIterator iterator()
- Specified by:
iterator
in interfaceTLongCharMap
- Returns:
- a TLongCharIterator with access to this map's keys and values
-
forEachKey
public boolean forEachKey(TLongProcedure procedure)
Executes procedure for each key in the map.- Specified by:
forEachKey
in interfaceTLongCharMap
- Parameters:
procedure
- aTLongProcedure
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 interfaceTLongCharMap
- Parameters:
procedure
- aT#F#Procedure
value- Returns:
- false if the loop over the values terminated because the procedure returned false for some value.
-
forEachEntry
public boolean forEachEntry(TLongCharProcedure procedure)
Executes procedure for each key/value entry in the map.- Specified by:
forEachEntry
in interfaceTLongCharMap
- Parameters:
procedure
- aTOLongCharProcedure
value- Returns:
- false if the loop over the entries terminated because the procedure returned false for some entry.
-
transformValues
public void transformValues(TCharFunction function)
Transform the values in this map using function.- Specified by:
transformValues
in interfaceTLongCharMap
- Parameters:
function
- aTCharFunction
value
-
retainEntries
public boolean retainEntries(TLongCharProcedure procedure)
Retains only those entries in the map for which the procedure returns a true value.- Specified by:
retainEntries
in interfaceTLongCharMap
- Parameters:
procedure
- determines which entries to keep- Returns:
- true if the map was modified.
-
increment
public boolean increment(long key)
Increments the primitive value mapped to key by 1- Specified by:
increment
in interfaceTLongCharMap
- Parameters:
key
- the key of the value to increment- Returns:
- true if a mapping was found and modified.
-
adjustValue
public boolean adjustValue(long key, char amount)
Adjusts the primitive value mapped to key.- Specified by:
adjustValue
in interfaceTLongCharMap
- Parameters:
key
- the key of the value to incrementamount
- the amount to adjust the value by.- Returns:
- true if a mapping was found and modified.
-
adjustOrPutValue
public char adjustOrPutValue(long 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 put_amount is put in the map.- Specified by:
adjustOrPutValue
in interfaceTLongCharMap
- Parameters:
key
- the key of the value to incrementadjust_amount
- the amount to adjust the value byput_amount
- the value put into the map if the key is not 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 classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
writeExternal
public void writeExternal(java.io.ObjectOutput out) throws java.io.IOException
- Specified by:
writeExternal
in interfacejava.io.Externalizable
- Overrides:
writeExternal
in classTLongCharHash
- Throws:
java.io.IOException
-
readExternal
public void readExternal(java.io.ObjectInput in) throws java.io.IOException, java.lang.ClassNotFoundException
- Specified by:
readExternal
in interfacejava.io.Externalizable
- Overrides:
readExternal
in classTLongCharHash
- Throws:
java.io.IOException
java.lang.ClassNotFoundException
-
-