|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectit.unimi.dsi.fastutil.ints.AbstractInt2IntFunction
it.unimi.dsi.fastutil.ints.AbstractInt2IntMap
it.unimi.dsi.fastutil.ints.AbstractInt2IntSortedMap
it.unimi.dsi.fastutil.ints.Int2IntLinkedOpenHashMap
public class Int2IntLinkedOpenHashMap
A type-specific linked hash map with with a fast, small-footprint implementation.
Instances of this class use a hash table to represent a map. The table is
enlarged as needed by doubling its size when new entries are created, but it is never made
smaller (even on a clear()
). A family of trimming
methods lets you control the size of the table; this is particularly useful
if you reuse instances of this class.
Iterators generated by this map will enumerate pairs in the same order in which they have been added to the map (addition of pairs whose key is already present in the set does not change the iteration order). Note that this order has nothing in common with the natural order of the keys. The order is kept by means of a doubly linked list, represented via an array of longs parallel to the table.
This class implements the interface of a sorted map, so to allow easy
access of the iteration order: for instance, you can get the first key
in iteration order with AbstractInt2IntSortedMap.firstKey()
without having to create an
iterator; however, this class partially violates the SortedMap
contract because all submap methods throw an exception and comparator()
returns always null
.
Additional methods, such as getAndMoveToFirst()
, make it easy
to use instances of this class as a cache (e.g., with LRU policy).
The iterators provided by the views of this class using are type-specific
list iterators, and can be started at any
element which is a key of the map, or
a NoSuchElementException
exception will be thrown.
If, however, the provided element is not the first or last key in the
set, the first access to the list index will require linear time, as in the worst case
the entire key set must be scanned in iteration order to retrieve the positional
index of the starting key. If you use just the methods of a type-specific BidirectionalIterator
,
however, all operations will be performed in constant time.
Hash
,
HashCommon
,
Serialized FormNested Class Summary |
---|
Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2IntSortedMap |
---|
AbstractInt2IntSortedMap.KeySetIterator, AbstractInt2IntSortedMap.ValuesCollection, AbstractInt2IntSortedMap.ValuesIterator |
Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2IntMap |
---|
AbstractInt2IntMap.BasicEntry |
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.Hash |
---|
Hash.Strategy<K> |
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.ints.Int2IntSortedMap |
---|
Int2IntSortedMap.FastSortedEntrySet |
Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.ints.Int2IntMap |
---|
Int2IntMap.Entry, Int2IntMap.FastEntrySet |
Field Summary | |
---|---|
protected Int2IntSortedMap.FastSortedEntrySet |
entries
Cached set of entries. |
protected float |
f
The acceptable load factor. |
protected int |
first
The index of the first entry in iteration order. |
protected int[] |
key
The array of keys. |
protected IntSortedSet |
keys
Cached set of keys. |
protected int |
last
The index of the last entry in iteration order. |
protected long[] |
link
For each entry, the next and the previous entry in iteration order, stored as ((prev & 0xFFFFFFFFL) << 32) | (next & 0xFFFFFFFFL) . |
protected int |
mask
The mask for wrapping a position counter. |
protected int |
maxFill
Threshold after which we rehash. |
protected int |
n
The current table size. |
static long |
serialVersionUID
|
protected int |
size
Number of entries in the set. |
protected boolean[] |
used
The array telling whether a position is used. |
protected int[] |
value
The array of values. |
protected IntCollection |
values
Cached collection of values. |
Fields inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2IntFunction |
---|
defRetValue |
Fields inherited from interface it.unimi.dsi.fastutil.Hash |
---|
DEFAULT_GROWTH_FACTOR, DEFAULT_INITIAL_SIZE, DEFAULT_LOAD_FACTOR, FAST_LOAD_FACTOR, FREE, OCCUPIED, PRIMES, REMOVED, VERY_FAST_LOAD_FACTOR |
Constructor Summary | |
---|---|
Int2IntLinkedOpenHashMap()
Creates a new hash map with initial expected Hash.DEFAULT_INITIAL_SIZE entries
and Hash.DEFAULT_LOAD_FACTOR as load factor. |
|
Int2IntLinkedOpenHashMap(int expected)
Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor. |
|
Int2IntLinkedOpenHashMap(int[] k,
int[] v)
Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor using the elements of two parallel arrays. |
|
Int2IntLinkedOpenHashMap(int[] k,
int[] v,
float f)
Creates a new hash map using the elements of two parallel arrays. |
|
Int2IntLinkedOpenHashMap(Int2IntMap m)
Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor copying a given type-specific one. |
|
Int2IntLinkedOpenHashMap(Int2IntMap m,
float f)
Creates a new hash map copying a given type-specific one. |
|
Int2IntLinkedOpenHashMap(int expected,
float f)
Creates a new hash map. |
|
Int2IntLinkedOpenHashMap(Map<? extends Integer,? extends Integer> m)
Creates a new hash map with Hash.DEFAULT_LOAD_FACTOR as load factor copying a given one. |
|
Int2IntLinkedOpenHashMap(Map<? extends Integer,? extends Integer> m,
float f)
Creates a new hash map copying a given one. |
Method Summary | |
---|---|
int |
add(int k,
int incr)
Adds an increment to value currently associated with a key. |
void |
clear()
Removes all associations from this function (optional operation). |
Int2IntLinkedOpenHashMap |
clone()
Returns a deep copy of this map. |
IntComparator |
comparator()
Returns the comparator associated with this sorted set, or null if it uses its keys' natural ordering. |
boolean |
containsKey(int k)
Checks whether the given value is contained in AbstractInt2IntMap.keySet() . |
boolean |
containsValue(int v)
Checks whether the given value is contained in AbstractInt2IntMap.values() . |
int |
firstIntKey()
Returns the first key of this map in iteration order. |
protected void |
fixPointers(int i)
Modifies the link vector so that the given entry is removed. |
protected void |
fixPointers(int s,
int d)
Modifies the link vector for a shift from s to d. |
int |
get(int k)
Returns the value to which the given key is mapped. |
Integer |
get(Integer ok)
|
int |
getAndMoveToFirst(int k)
Returns the value to which the given key is mapped; if the key is present, it is moved to the first position of the iteration order. |
int |
getAndMoveToLast(int k)
Returns the value to which the given key is mapped; if the key is present, it is moved to the last position of the iteration order. |
int |
growthFactor()
Deprecated. Since fastutil 6.1.0, hash tables are doubled when they are too full. |
void |
growthFactor(int growthFactor)
Deprecated. Since fastutil 6.1.0, hash tables are doubled when they are too full. |
int |
hashCode()
Returns a hash code for this map. |
Int2IntSortedMap |
headMap(int to)
Returns a view of the portion of this sorted map whose keys are strictly less than toKey . |
Int2IntSortedMap.FastSortedEntrySet |
int2IntEntrySet()
Returns a type-specific sorted-set view of the mappings contained in this map. |
boolean |
isEmpty()
|
IntSortedSet |
keySet()
Returns a type-specific-sorted-set view of the keys of this map. |
int |
lastIntKey()
Returns the last key of this map in iteration order. |
Integer |
put(Integer ok,
Integer ov)
Delegates to the corresponding type-specific method, taking care of returning null on a missing key. |
int |
put(int k,
int v)
Adds a pair to the map. |
int |
putAndMoveToFirst(int k,
int v)
Adds a pair to the map; if the key is already present, it is moved to the first position of the iteration order. |
int |
putAndMoveToLast(int k,
int v)
Adds a pair to the map; if the key is already present, it is moved to the last position of the iteration order. |
boolean |
rehash()
Deprecated. A no-op. |
protected void |
rehash(int newN)
Resizes the map. |
int |
remove(int k)
Removes the mapping with the given key. |
Integer |
remove(Object ok)
Delegates to the corresponding type-specific method, taking care of returning null on a missing key. |
int |
removeFirstInt()
Removes the mapping associated with the first key in iteration order. |
int |
removeLastInt()
Removes the mapping associated with the last key in iteration order. |
protected int |
shiftKeys(int pos)
Shifts left entries with the specified hash code, starting at the specified position, and empties the resulting free entry. |
int |
size()
Returns the intended number of keys in this function, or -1 if no such number exists. |
Int2IntSortedMap |
subMap(int from,
int to)
Returns a view of the portion of this sorted map whose keys range from fromKey , inclusive, to toKey , exclusive. |
Int2IntSortedMap |
tailMap(int from)
Returns a view of the portion of this sorted map whose keys are greater than or equal to fromKey . |
boolean |
trim()
Rehashes the map, making the table as small as possible. |
boolean |
trim(int n)
Rehashes this map if the table is too large. |
IntCollection |
values()
Returns a type-specific collection view of the values contained in this map. |
Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2IntSortedMap |
---|
entrySet, firstKey, headMap, lastKey, subMap, tailMap |
Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2IntMap |
---|
containsValue, equals, putAll, toString |
Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2IntFunction |
---|
containsKey, defaultReturnValue, defaultReturnValue, get |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface it.unimi.dsi.fastutil.ints.Int2IntFunction |
---|
defaultReturnValue, defaultReturnValue |
Methods inherited from interface it.unimi.dsi.fastutil.Function |
---|
containsKey, get |
Methods inherited from interface java.util.Map |
---|
containsKey, containsValue, equals, get, putAll |
Field Detail |
---|
public static final long serialVersionUID
protected transient int[] key
protected transient int[] value
protected transient boolean[] used
protected final float f
protected transient int n
protected transient int maxFill
f
.
protected transient int mask
protected int size
protected transient volatile Int2IntSortedMap.FastSortedEntrySet entries
protected transient volatile IntSortedSet keys
protected transient volatile IntCollection values
protected transient int first
size
is nonzero; otherwise, it contains -1.
protected transient int last
size
is nonzero; otherwise, it contains -1.
protected transient long[] link
((prev & 0xFFFFFFFFL) << 32) | (next & 0xFFFFFFFFL)
.
The first entry contains predecessor -1, and the last entry
contains successor -1.
Constructor Detail |
---|
public Int2IntLinkedOpenHashMap(int expected, float f)
The actual table size will be the least power of two greater than expected
/f
.
expected
- the expected number of elements in the hash set.f
- the load factor.public Int2IntLinkedOpenHashMap(int expected)
Hash.DEFAULT_LOAD_FACTOR
as load factor.
expected
- the expected number of elements in the hash map.public Int2IntLinkedOpenHashMap()
Hash.DEFAULT_INITIAL_SIZE
entries
and Hash.DEFAULT_LOAD_FACTOR
as load factor.
public Int2IntLinkedOpenHashMap(Map<? extends Integer,? extends Integer> m, float f)
m
- a Map
to be copied into the new hash map.f
- the load factor.public Int2IntLinkedOpenHashMap(Map<? extends Integer,? extends Integer> m)
Hash.DEFAULT_LOAD_FACTOR
as load factor copying a given one.
m
- a Map
to be copied into the new hash map.public Int2IntLinkedOpenHashMap(Int2IntMap m, float f)
m
- a type-specific map to be copied into the new hash map.f
- the load factor.public Int2IntLinkedOpenHashMap(Int2IntMap m)
Hash.DEFAULT_LOAD_FACTOR
as load factor copying a given type-specific one.
m
- a type-specific map to be copied into the new hash map.public Int2IntLinkedOpenHashMap(int[] k, int[] v, float f)
k
- the array of keys of the new hash map.v
- the array of corresponding values in the new hash map.f
- the load factor.
IllegalArgumentException
- if k
and v
have different lengths.public Int2IntLinkedOpenHashMap(int[] k, int[] v)
Hash.DEFAULT_LOAD_FACTOR
as load factor using the elements of two parallel arrays.
k
- the array of keys of the new hash map.v
- the array of corresponding values in the new hash map.
IllegalArgumentException
- if k
and v
have different lengths.Method Detail |
---|
public int put(int k, int v)
Int2IntFunction
put
in interface Int2IntFunction
put
in class AbstractInt2IntFunction
k
- the key.v
- the value.
Function.put(Object,Object)
public Integer put(Integer ok, Integer ov)
AbstractInt2IntFunction
null
on a missing key.
This method must check whether the provided key is in the map using containsKey()
. Thus,
it probes the map twice. Implementors of subclasses should override it with a more efficient method.
put
in interface Function<Integer,Integer>
put
in interface Map<Integer,Integer>
put
in class AbstractInt2IntFunction
ok
- the key.ov
- the value.
null
if no value was present for the given key.Map.put(Object,Object)
public int add(int k, int incr)
Note that this method respects the default return value semantics: when called with a key that does not currently appears in the map, the key will be associated with the default return value plus the given increment.
k
- the key.incr
- the increment.
protected final int shiftKeys(int pos)
pos
- a starting position.
public int remove(int k)
Int2IntFunction
remove
in interface Int2IntFunction
remove
in class AbstractInt2IntFunction
Function.remove(Object)
public Integer remove(Object ok)
AbstractInt2IntFunction
null
on a missing key.
This method must check whether the provided key is in the map using containsKey()
. Thus,
it probes the map twice. Implementors of subclasses should override it with a more efficient method.
remove
in interface Function<Integer,Integer>
remove
in interface Map<Integer,Integer>
remove
in class AbstractInt2IntFunction
null
if no value was present for the given key.Map.remove(Object)
public int removeFirstInt()
NoSuchElementException
- is this map is empty.public int removeLastInt()
NoSuchElementException
- is this map is empty.public int getAndMoveToFirst(int k)
k
- the key.
public int getAndMoveToLast(int k)
k
- the key.
public int putAndMoveToFirst(int k, int v)
k
- the key.v
- the value.
public int putAndMoveToLast(int k, int v)
k
- the key.v
- the value.
public Integer get(Integer ok)
public int get(int k)
Int2IntFunction
get
in interface Int2IntFunction
k
- the key.
Function.get(Object)
public boolean containsKey(int k)
AbstractInt2IntMap
AbstractInt2IntMap.keySet()
.
containsKey
in interface Int2IntFunction
containsKey
in class AbstractInt2IntMap
Function.containsKey(Object)
public boolean containsValue(int v)
AbstractInt2IntMap
AbstractInt2IntMap.values()
.
containsValue
in interface Int2IntMap
containsValue
in class AbstractInt2IntMap
Map.containsValue(Object)
public void clear()
Function
clear
in interface Function<Integer,Integer>
clear
in interface Map<Integer,Integer>
clear
in class AbstractInt2IntFunction
Map.clear()
public int size()
Function
Most function implementations will have some knowledge of the intended number of keys in their domain. In some cases, however, this might not be possible.
size
in interface Function<Integer,Integer>
size
in interface Map<Integer,Integer>
public boolean isEmpty()
isEmpty
in interface Map<Integer,Integer>
isEmpty
in class AbstractInt2IntMap
@Deprecated public void growthFactor(int growthFactor)
fastutil
6.1.0, hash tables are doubled when they are too full.
growthFactor
- unused.@Deprecated public int growthFactor()
fastutil
6.1.0, hash tables are doubled when they are too full.
growthFactor(int)
protected void fixPointers(int i)
link
vector so that the given entry is removed.
If the given entry is the first or the last one, this method will complete in constant time; otherwise, it will have to search for the given entry.
i
- the index of an entry.protected void fixPointers(int s, int d)
link
vector for a shift from s to d.
If the given entry is the first or the last one, this method will complete in constant time; otherwise, it will have to search for the given entry.
s
- the source position.d
- the destination position.public int firstIntKey()
firstIntKey
in interface Int2IntSortedMap
SortedMap.firstKey()
public int lastIntKey()
lastIntKey
in interface Int2IntSortedMap
SortedMap.lastKey()
public IntComparator comparator()
Int2IntSortedMap
Note that this specification strengthens the one given in SortedMap.comparator()
.
comparator
in interface Int2IntSortedMap
comparator
in interface SortedMap<Integer,Integer>
SortedMap.comparator()
public Int2IntSortedMap tailMap(int from)
Int2IntSortedMap
fromKey
.
tailMap
in interface Int2IntSortedMap
SortedMap.tailMap(Object)
public Int2IntSortedMap headMap(int to)
Int2IntSortedMap
toKey
.
headMap
in interface Int2IntSortedMap
SortedMap.headMap(Object)
public Int2IntSortedMap subMap(int from, int to)
Int2IntSortedMap
fromKey
, inclusive, to toKey
, exclusive.
subMap
in interface Int2IntSortedMap
SortedMap.subMap(Object,Object)
public Int2IntSortedMap.FastSortedEntrySet int2IntEntrySet()
Int2IntSortedMap
int2IntEntrySet
in interface Int2IntMap
int2IntEntrySet
in interface Int2IntSortedMap
Int2IntSortedMap.entrySet()
public IntSortedSet keySet()
AbstractInt2IntSortedMap
The view is backed by the sorted set returned by AbstractInt2IntSortedMap.entrySet()
. Note that
no attempt is made at caching the result of this method, as this would
require adding some attributes that lightweight implementations would
not need. Subclasses may easily override this policy by calling
this method and caching the result, but implementors are encouraged to
write more efficient ad-hoc implementations.
keySet
in interface Int2IntMap
keySet
in interface Int2IntSortedMap
keySet
in interface Map<Integer,Integer>
keySet
in interface SortedMap<Integer,Integer>
keySet
in class AbstractInt2IntSortedMap
Map.keySet()
public IntCollection values()
AbstractInt2IntSortedMap
The view is backed by the sorted set returned by AbstractInt2IntSortedMap.entrySet()
. Note that
no attempt is made at caching the result of this method, as this would
require adding some attributes that lightweight implementations would
not need. Subclasses may easily override this policy by calling
this method and caching the result, but implementors are encouraged to
write more efficient ad-hoc implementations.
values
in interface Int2IntMap
values
in interface Int2IntSortedMap
values
in interface Map<Integer,Integer>
values
in interface SortedMap<Integer,Integer>
values
in class AbstractInt2IntSortedMap
Map.values()
@Deprecated public boolean rehash()
If you need to reduce the table size to fit exactly
this set, use trim()
.
trim()
public boolean trim()
This method rehashes the table to the smallest size satisfying the load factor. It can be used when the set will not be changed anymore, so to optimize access speed and size.
If the table size is already the minimum possible, this method does nothing.
trim(int)
public boolean trim(int n)
Let N be the smallest table size that can hold
max(n,
entries, still satisfying the load factor. If the current
table size is smaller than or equal to N, this method does
nothing. Otherwise, it rehashes this map in a table of size
N.
size()
)
This method is useful when reusing maps. Clearing a map leaves the table size untouched. If you are reusing a map many times, you can call this method with a typical size to avoid keeping around a very large table just because of a few large transient maps.
n
- the threshold for the trimming.
trim()
protected void rehash(int newN)
This method implements the basic rehashing strategy, and may be overriden by subclasses implementing different rehashing strategies (e.g., disk-based rehashing). However, you should not override this method unless you understand the internal workings of this class.
newN
- the new sizepublic Int2IntLinkedOpenHashMap clone()
This method performs a deep copy of this hash map; the data stored in the map, however, is not cloned. Note that this makes a difference only for object keys.
clone
in class Object
public int hashCode()
equals()
is not overriden, it is important
that the value returned by this method is the same value as
the one returned by the overriden method.
hashCode
in interface Map<Integer,Integer>
hashCode
in class AbstractInt2IntMap
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |