LongIntMap (mini2Dx-core 2.0.0-alpha.91 API)

java.lang.Object
- org.mini2Dx.core.collections.LongIntMap

All Implemented Interfaces:: java.lang.Iterable<LongIntMap.Entry>

public class LongIntMap
extends java.lang.Object
implements java.lang.Iterable<LongIntMap.Entry>

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`LongIntMap.Entries`
`static class`	`LongIntMap.Entry`
`static class`	`LongIntMap.Keys`
`static class`	`LongIntMap.Values`

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`mask` A bitmask used to confine hashcodes to the size of the table.
`protected int`	`shift` Used by `place(long)` to bit shift the upper bits of a `long` into a usable range (>= 0 and <= `mask`).
`int`	`size`

Constructor Summary

Constructors
Constructor and Description
`LongIntMap()` Creates a new map with an initial capacity of 51 and a load factor of 0.8.
`LongIntMap(int initialCapacity)` Creates a new map with a load factor of 0.8.
`LongIntMap(int initialCapacity, float loadFactor)` Creates a new map with the specified initial capacity and load factor.
`LongIntMap(LongIntMap map)` Creates a new map identical to the specified map.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()`
`void`	`clear(int maximumCapacity)` Clears the map and reduces the size of the backing arrays to be the specified capacity / loadFactor, if they are larger.
`boolean`	`containsKey(long key)`
`boolean`	`containsValue(int value)` Returns true if the specified value is in the map.
`void`	`ensureCapacity(int additionalCapacity)` Increases the size of the backing array to accommodate the specified number of additional items / loadFactor.
`LongIntMap.Entries`	`entries()` Returns an iterator for the entries in the map.
`boolean`	`equals(java.lang.Object obj)`
`long`	`findKey(int value, long notFound)` Returns the key for the specified value, or null if it is not in the map.
`int`	`get(long key)`
`int`	`get(long key, int defaultValue)`
`int`	`hashCode()`
`boolean`	`isEmpty()` Returns true if the map is empty.
`java.util.Iterator<LongIntMap.Entry>`	`iterator()`
`LongIntMap.Keys`	`keys()` Returns an iterator for the keys in the map.
`boolean`	`notEmpty()` Returns true if the map has one or more items.
`protected int`	`place(long item)` Returns an index >= 0 and <= `mask` for the specified `item`.
`void`	`put(long key, int value)`
`int`	`put(long key, int value, int defaultValue)`
`void`	`putAll(LongIntMap map)`
`int`	`remove(long key, int defaultValue)` Returns the value for the removed key, or null if the key is not in the map.
`void`	`shrink(int maximumCapacity)` Reduces the size of the backing arrays to be the specified capacity / loadFactor, or less.
`java.lang.String`	`toString()`
`LongIntMap.Values`	`values()` Returns an iterator for the values in the map.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - size
```
public int size
```
  - shift
```
protected int shift
```
    Used by place(long) to bit shift the upper bits of a long into a usable range (>= 0 and <= mask). The shift can be negative, which is convenient to match the number of bits in mask: if mask is a 7-bit number, a shift of -7 shifts the upper 7 bits into the lowest 7 positions. This class sets the shift > 32 and < 64, which if used with an int will still move the upper bits of an int to the lower bits due to Java's implicit modulus on shifts.
    mask can also be used to mask the low bits of a number, which may be faster for some hashcodes, if place(long) is overridden.
  - mask
```
protected int mask
```
    A bitmask used to confine hashcodes to the size of the table. Must be all 1 bits in its low positions, ie a power of two minus 1. If place(long) is overriden, this can be used instead of shift to isolate usable bits of a hash.
- Constructor Detail
  - LongIntMap
```
public LongIntMap()
```
    Creates a new map with an initial capacity of 51 and a load factor of 0.8.
  - LongIntMap
```
public LongIntMap(int initialCapacity)
```
    Creates a new map with a load factor of 0.8.
    
    Parameters:
    
    initialCapacity - If not a power of two, it is increased to the next nearest power of two.
  - LongIntMap
```
public LongIntMap(int initialCapacity,
                  float loadFactor)
```
    Creates a new map with the specified initial capacity and load factor. This map will hold initialCapacity items before growing the backing table.
    
    Parameters:
    
    initialCapacity - If not a power of two, it is increased to the next nearest power of two.
  - LongIntMap
```
public LongIntMap(LongIntMap map)
```
    Creates a new map identical to the specified map.
- Method Detail
  - place
```
protected int place(long item)
```
    Returns an index >= 0 and <= mask for the specified item.
    The default implementation uses Fibonacci hashing on the item's Object.hashCode(): the hashcode is multiplied by a long constant (2 to the 64th, divided by the golden ratio) then the uppermost bits are shifted into the lowest positions to obtain an index in the desired range. Multiplication by a long may be slower than int (eg on GWT) but greatly improves rehashing, allowing even very poor hashcodes, such as those that only differ in their upper bits, to be used without high collision rates. Fibonacci hashing has increased collision rates when all or most hashcodes are multiples of larger Fibonacci numbers (see Malte Skarupke's blog post).
    This method can be overriden to customizing hashing. This may be useful eg in the unlikely event that most hashcodes are Fibonacci numbers, if keys provide poor or incorrect hashcodes, or to simplify hashing if keys provide high quality hashcodes and don't need Fibonacci hashing: return item.hashCode() & mask;
  - put
```
public void put(long key,
                int value)
```
  - put
```
public int put(long key,
               int value,
               int defaultValue)
```
  - putAll
```
public void putAll(LongIntMap map)
```
  - get
```
public int get(long key)
```
  - get
```
public int get(long key,
               int defaultValue)
```
  - remove
```
public int remove(long key,
                  int defaultValue)
```
    Returns the value for the removed key, or null if the key is not in the map.
  - notEmpty
```
public boolean notEmpty()
```
    Returns true if the map has one or more items.
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if the map is empty.
  - shrink
```
public void shrink(int maximumCapacity)
```
    Reduces the size of the backing arrays to be the specified capacity / loadFactor, or less. If the capacity is already less, nothing is done. If the map contains more items than the specified capacity, the next highest power of two capacity is used instead.
  - clear
```
public void clear(int maximumCapacity)
```
    Clears the map and reduces the size of the backing arrays to be the specified capacity / loadFactor, if they are larger.
  - clear
```
public void clear()
```
  - containsValue
```
public boolean containsValue(int value)
```
    Returns true if the specified value is in the map. Note this traverses the entire map and compares every value, which may be an expensive operation.
  - containsKey
```
public boolean containsKey(long key)
```
  - findKey
```
public long findKey(int value,
                    long notFound)
```
    Returns the key for the specified value, or null if it is not in the map. Note this traverses the entire map and compares every value, which may be an expensive operation.
  - ensureCapacity
```
public void ensureCapacity(int additionalCapacity)
```
    Increases the size of the backing array to accommodate the specified number of additional items / loadFactor. Useful before adding many items to avoid multiple backing array resizes.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - iterator
```
public java.util.Iterator<LongIntMap.Entry> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<LongIntMap.Entry>
  - entries
```
public LongIntMap.Entries entries()
```
    Returns an iterator for the entries in the map. Remove is supported.
    If Collections.allocateIterators is false, the same iterator instance is returned each time this method is called. Use the LongIntMap.Entries constructor for nested or multithreaded iteration.
  - values
```
public LongIntMap.Values values()
```
    Returns an iterator for the values in the map. Remove is supported.
    If Collections.allocateIterators is false, the same iterator instance is returned each time this method is called. Use the LongIntMap.Entries constructor for nested or multithreaded iteration.
  - keys
```
public LongIntMap.Keys keys()
```
    Returns an iterator for the keys in the map. Remove is supported.
    If Collections.allocateIterators is false, the same iterator instance is returned each time this method is called. Use the LongIntMap.Entries constructor for nested or multithreaded iteration.

Class LongIntMap

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

size

shift

mask

Constructor Detail

LongIntMap

LongIntMap

LongIntMap

LongIntMap

Method Detail

place

put

put

putAll

get

get

remove

notEmpty

isEmpty

shrink

clear

clear

containsValue

containsKey

findKey

ensureCapacity

hashCode

equals

toString

iterator

entries

values

keys