|
GNU Trove | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object gnu.trove.impl.hash.THash gnu.trove.impl.hash.TObjectHash<K> gnu.trove.map.hash.TObjectLongHashMap<K>
public class TObjectLongHashMap<K>
An open addressed Map implementation for Object keys and long values. Created: Sun Nov 4 08:52:45 2001
Nested Class Summary | |
---|---|
protected class |
TObjectLongHashMap.KeyView
a view onto the keys of the map. |
Field Summary | |
---|---|
protected long[] |
_values
the values of the map |
protected long |
no_entry_value
the value that represents null |
Fields inherited from class gnu.trove.impl.hash.TObjectHash |
---|
_set, consumeFreeSlot, FREE, REMOVED |
Fields inherited from class gnu.trove.impl.hash.THash |
---|
_autoCompactionFactor, _autoCompactRemovesRemaining, _autoCompactTemporaryDisable, _free, _loadFactor, _maxSize, _size, DEFAULT_CAPACITY, DEFAULT_LOAD_FACTOR |
Constructor Summary | |
---|---|
TObjectLongHashMap()
Creates a new TObjectLongHashMap instance with the default
capacity and load factor. |
|
TObjectLongHashMap(int initialCapacity)
Creates a new TObjectLongHashMap instance with a prime
capacity equal to or greater than initialCapacity and
with the default load factor. |
|
TObjectLongHashMap(int initialCapacity,
float loadFactor)
Creates a new TObjectLongHashMap instance with a prime
capacity equal to or greater than initialCapacity and
with the specified load factor. |
|
TObjectLongHashMap(int initialCapacity,
float loadFactor,
long noEntryValue)
Creates a new TObjectLongHashMap instance with a prime
value at or near the specified capacity and load factor. |
|
TObjectLongHashMap(TObjectLongMap<? extends K> map)
Creates a new TObjectLongHashMap that contains the entries
in the map passed to it. |
Method Summary | |
---|---|
long |
adjustOrPutValue(K key,
long adjust_amount,
long put_amount)
Adjusts the primitive value mapped to the key if the key is present in the map. |
boolean |
adjustValue(K key,
long amount)
Adjusts the primitive value mapped to key. |
void |
clear()
Empties the collection. |
boolean |
containsKey(java.lang.Object key)
Returns true if this map contains a mapping for the specified key. |
boolean |
containsValue(long val)
Returns true if this map maps one or more keys to the specified value. |
boolean |
equals(java.lang.Object other)
Compares this map with another map for equality of their stored entries. |
boolean |
forEachEntry(TObjectLongProcedure<? super K> procedure)
Executes procedure for each key/value entry in the map. |
boolean |
forEachKey(TObjectProcedure<? super K> procedure)
Executes procedure for each key in the map. |
boolean |
forEachValue(TLongProcedure procedure)
Executes procedure for each value in the map. |
long |
get(java.lang.Object key)
Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key. |
long |
getNoEntryValue()
Returns the value that will be returned from TObjectLongMap.get(java.lang.Object) or TObjectLongMap.put(K, long) if no
entry exists for a given key. |
int |
hashCode()
Returns the hash code value for this map. |
boolean |
increment(K key)
Increments the primitive value mapped to key by 1 |
TObjectLongIterator<K> |
iterator()
Returns a TObjectLongIterator with access to this map's keys and values. |
java.lang.Object[] |
keys()
Returns a copy of the keys of the map as an array. |
K[] |
keys(K[] a)
Returns a copy of the keys of the map as an array. |
java.util.Set<K> |
keySet()
Returns a Set view of the keys contained in this map. |
long |
put(K key,
long value)
Associates the specified value with the specified key in this map (optional operation). |
void |
putAll(java.util.Map<? extends K,? extends java.lang.Long> map)
Copies all of the mappings from the specified map to this map (optional operation). |
void |
putAll(TObjectLongMap<? extends K> map)
Put all the entries from the given map into this map. |
long |
putIfAbsent(K key,
long 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 map to the new capacity. |
long |
remove(java.lang.Object key)
Removes the mapping for a key from this map if it is present (optional operation). |
protected void |
removeAt(int index)
Removes the mapping at index from the map. |
boolean |
retainEntries(TObjectLongProcedure<? super K> procedure)
Retains only those entries in the map for which the procedure returns a true value. |
int |
setUp(int initialCapacity)
initializes the hashtable to a prime capacity which is at least initialCapacity + 1. |
java.lang.String |
toString()
|
void |
transformValues(TLongFunction function)
Transform the values in this map using function. |
TLongCollection |
valueCollection()
Returns a TLongCollection view of the values contained in this map. |
long[] |
values()
Returns the values of the map as an array of long values. |
long[] |
values(long[] 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.TObjectHash |
---|
buildObjectContractViolation, capacity, contains, dumpExtraInfo, equals, forEach, hash, index, insertionIndex, insertKey, objectInfo, reportPotentialConcurrentMod, throwObjectContractViolation, throwObjectContractViolation |
Methods inherited from class gnu.trove.impl.hash.THash |
---|
calculateGrownCapacity, compact, computeMaxSize, computeNextAutoCompactionAmount, ensureCapacity, getAutoCompactionFactor, isEmpty, 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.TObjectLongMap |
---|
isEmpty, size |
Field Detail |
---|
protected transient long[] _values
protected long no_entry_value
Constructor Detail |
---|
public TObjectLongHashMap()
TObjectLongHashMap
instance with the default
capacity and load factor.
public TObjectLongHashMap(int initialCapacity)
TObjectLongHashMap
instance with a prime
capacity equal to or greater than initialCapacity and
with the default load factor.
initialCapacity
- an int
valuepublic TObjectLongHashMap(int initialCapacity, float loadFactor)
TObjectLongHashMap
instance with a prime
capacity equal to or greater than initialCapacity and
with the specified load factor.
initialCapacity
- an int
valueloadFactor
- a float
valuepublic TObjectLongHashMap(int initialCapacity, float loadFactor, long noEntryValue)
TObjectLongHashMap
instance with a prime
value at or near the specified capacity and load factor.
initialCapacity
- used to find a prime capacity for the table.loadFactor
- used to calculate the threshold over which
rehashing takes place.noEntryValue
- the value used to represent null.public TObjectLongHashMap(TObjectLongMap<? extends K> map)
TObjectLongHashMap
that contains the entries
in the map passed to it.
map
- the TObjectLongMap to be copied.Method Detail |
---|
public int setUp(int initialCapacity)
setUp
in class gnu.trove.impl.hash.TObjectHash<K>
initialCapacity
- an int
value
protected void rehash(int newCapacity)
rehash
in class gnu.trove.impl.hash.THash
newCapacity
- an int
valuepublic long getNoEntryValue()
TObjectLongMap.get(java.lang.Object)
or TObjectLongMap.put(K, long)
if no
entry exists for a given key. The default value is generally zero, but can be
changed during construction of the collection.
getNoEntryValue
in interface TObjectLongMap<K>
public boolean containsKey(java.lang.Object key)
containsKey
in interface TObjectLongMap<K>
key
- key whose presence in this map is to be tested
public boolean containsValue(long val)
TObjectLongMap.getNoEntryValue()
and represents
null for this map instance.
containsValue
in interface TObjectLongMap<K>
val
- long value whose presence in this map is to be tested
public long get(java.lang.Object key)
null
if this map contains no mapping for the key.
More formally, if this map contains a mapping from a key
k
to a value v
such that (key==null ? k==null :
key.equals(k))
, then this method returns v
; otherwise
it returns null
. (There can be at most one such mapping.)
If this map permits null values, then a return value of
null
does not necessarily indicate that the map
contains no mapping for the key; it's also possible that the map
explicitly maps the key to null
. The containsKey
operation may be used to distinguish these two cases.
get
in interface TObjectLongMap<K>
key
- the key whose associated value is to be returned
null
if this map contains no mapping for the keypublic long put(K key, long value)
m.containsKey(k)
would return
true.)
put
in interface TObjectLongMap<K>
key
- key with which the specified value is to be associatedvalue
- an long value value to be associated with the specified key
TObjectLongMap.getNoEntryValue()
public long putIfAbsent(K key, long value)
putIfAbsent
in interface TObjectLongMap<K>
key
- key with which the specified value is to be associatedvalue
- an long value to be associated with the specified key
TObjectLongMap.getNoEntryValue()
).public long remove(java.lang.Object key)
(key==null ? k==null : key.equals(k))
, that mapping
is removed. (The map can contain at most one such mapping.)
Returns the value to which this map previously associated the key, or null if the map contained no mapping for the key.
If this map permits null values, then a return value of null does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key to null.
The map will not contain a mapping for the specified key once the call returns.
remove
in interface TObjectLongMap<K>
key
- key whose mapping is to be removed from the map
protected void removeAt(int index)
removeAt
in class gnu.trove.impl.hash.TObjectHash<K>
index
- an int
valuepublic void putAll(java.util.Map<? extends K,? extends java.lang.Long> map)
put(k, v)
on this map once
for each mapping from key k to value v in the
specified map. The behavior of this operation is undefined if the
specified map is modified while the operation is in progress.
putAll
in interface TObjectLongMap<K>
map
- mappings to be stored in this mappublic void putAll(TObjectLongMap<? extends K> map)
putAll
in interface TObjectLongMap<K>
map
- The map from which entries will be obtained to put into this map.public void clear()
clear
in interface TObjectLongMap<K>
clear
in class gnu.trove.impl.hash.THash
public java.util.Set<K> keySet()
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. If the map is modified
while an iteration over the set is in progress (except through
the iterator's own remove operation), the results of
the iteration are undefined. The set supports element removal,
which removes the corresponding mapping from the map, via the
Iterator.remove, Set.remove,
removeAll, retainAll, and clear
operations. It does not support the add or addAll
operations.
keySet
in interface TObjectLongMap<K>
public java.lang.Object[] keys()
keys
in interface TObjectLongMap<K>
public K[] keys(K[] a)
keys
in interface TObjectLongMap<K>
a
- 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.
public TLongCollection valueCollection()
TLongCollection
view of the values contained in this map.
The collection is backed by the map, so changes to the map are
reflected in the collection, and vice-versa. If the map is
modified while an iteration over the collection is in progress
(except through the iterator's own remove operation),
the results of the iteration are undefined. The collection
supports element removal, which removes the corresponding
mapping from the map, via the TLongIterator.remove,
TLongCollection.remove, removeAll,
retainAll and clear operations. It does not
support the add or addAll operations.
valueCollection
in interface TObjectLongMap<K>
public long[] values()
values
in interface TObjectLongMap<K>
public long[] values(long[] array)
values
in interface TObjectLongMap<K>
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.
public TObjectLongIterator<K> iterator()
TObjectLongMap
iterator
in interface TObjectLongMap<K>
public boolean increment(K key)
increment
in interface TObjectLongMap<K>
key
- the key of the value to increment
public boolean adjustValue(K key, long amount)
adjustValue
in interface TObjectLongMap<K>
key
- the key of the value to incrementamount
- the amount to adjust the value by.
public long adjustOrPutValue(K key, long adjust_amount, long put_amount)
adjustOrPutValue
in interface TObjectLongMap<K>
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 initial present
public boolean forEachKey(TObjectProcedure<? super K> procedure)
forEachKey
in interface TObjectLongMap<K>
procedure
- a TObjectProcedure
value
public boolean forEachValue(TLongProcedure procedure)
forEachValue
in interface TObjectLongMap<K>
procedure
- a TLongProcedure
value
public boolean forEachEntry(TObjectLongProcedure<? super K> procedure)
forEachEntry
in interface TObjectLongMap<K>
procedure
- a TOObjectLongProcedure
value
public boolean retainEntries(TObjectLongProcedure<? super K> procedure)
retainEntries
in interface TObjectLongMap<K>
procedure
- determines which entries to keep
public void transformValues(TLongFunction function)
transformValues
in interface TObjectLongMap<K>
function
- a TLongFunction
valuepublic boolean equals(java.lang.Object other)
equals
in interface TObjectLongMap<K>
equals
in class java.lang.Object
other
- an Object
value
boolean
valuepublic int hashCode()
Object.hashCode()
.
hashCode
in interface TObjectLongMap<K>
hashCode
in class java.lang.Object
Object.equals(Object)
,
TObjectLongMap.equals(Object)
public void writeExternal(java.io.ObjectOutput out) throws java.io.IOException
writeExternal
in interface java.io.Externalizable
writeExternal
in class gnu.trove.impl.hash.TObjectHash<K>
java.io.IOException
public void readExternal(java.io.ObjectInput in) throws java.io.IOException, java.lang.ClassNotFoundException
readExternal
in interface java.io.Externalizable
readExternal
in class gnu.trove.impl.hash.TObjectHash<K>
java.io.IOException
java.lang.ClassNotFoundException
public java.lang.String toString()
toString
in class java.lang.Object
|
GNU Trove | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |