IntMap (miniscript-core 1.8.13 API)

java.lang.Object
- org.mini2Dx.miniscript.core.util.IntMap<V>

All Implemented Interfaces:

java.lang.Iterable<IntMap.Entry<V>>

Direct Known Subclasses:

ReadWriteIntMap
```
public class IntMap<V>
extends java.lang.Object
implements java.lang.Iterable<IntMap.Entry<V>>
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class IntMap.Entries<V>

static class IntMap.Entry<V>

static class IntMap.Keys

static class IntMap.Values<V>

Nested Classes
Modifier and Type	Class and Description
`static class`	`IntMap.Entries<V>`
`static class`	`IntMap.Entry<V>`
`static class`	`IntMap.Keys`
`static class`	`IntMap.Values<V>`

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(int)` to bit shift the upper bits of a `long` into a usable range (>= 0 and <= `mask`).
`int`	`size`

Constructor Summary

Constructors
Constructor and Description
`IntMap()` Creates a new map with an initial capacity of 51 and a load factor of 0.8.
`IntMap(int initialCapacity)` Creates a new map with a load factor of 0.8.
`IntMap(int initialCapacity, float loadFactor)` Creates a new map with the specified initial capacity and load factor.
`IntMap(IntMap<? extends V> 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(int key)`
`boolean`	`containsValue(java.lang.Object value, boolean identity)` 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.
`IntMap.Entries<V>`	`entries()`
`boolean`	`equals(java.lang.Object obj)`
`boolean`	`equalsIdentity(java.lang.Object obj)` Uses == for comparison of each value.
`int`	`findKey(java.lang.Object value, boolean identity, int notFound)` Returns the key for the specified value, or `notFound` if it is not in the map.
`V`	`get(int key)`
`V`	`get(int key, V defaultValue)`
`int`	`hashCode()`
`boolean`	`isEmpty()` Returns true if the map is empty.
`java.util.Iterator<IntMap.Entry<V>>`	`iterator()`
`IntMap.Keys`	`keys()`
`boolean`	`notEmpty()` Returns true if the map has one or more items.
`protected int`	`place(int item)` Returns an index >= 0 and <= `mask` for the specified `item`.
`V`	`put(int key, V value)`
`void`	`putAll(IntMap<? extends V> map)`
`V`	`remove(int key)` 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()`
`IntMap.Values<V>`	`values()`

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(int) 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(int) 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(int) is overriden, this can be used instead of shift to isolate usable bits of a hash.
- Constructor Detail
  - IntMap
```
public IntMap()
```
    Creates a new map with an initial capacity of 51 and a load factor of 0.8.
  - IntMap
```
public IntMap(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.
  - IntMap
```
public IntMap(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.
  - IntMap
```
public IntMap(IntMap<? extends V> map)
```
    Creates a new map identical to the specified map.
- Method Detail
  - place
```
protected int place(int 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 V put(int key,
             V value)
```
  - putAll
```
public void putAll(IntMap<? extends V> map)
```
  - get
```
public V get(int key)
```
  - get
```
public V get(int key,
             V defaultValue)
```
  - remove
```
public V remove(int key)
```
    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(java.lang.Object value,
                             boolean identity)
```
    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.
    
    Parameters:
    
    identity - If true, uses == to compare the specified value with values in the map. If false, uses equals(Object).
  - containsKey
```
public boolean containsKey(int key)
```
  - findKey
```
public int findKey(java.lang.Object value,
                   boolean identity,
                   int notFound)
```
    Returns the key for the specified value, or notFound if it is not in the map. Note this traverses the entire map and compares every value, which may be an expensive operation.
    
    Parameters:
    
    identity - If true, uses == to compare the specified value with values in the map. If false, uses equals(Object).
  - 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
  - equalsIdentity
```
public boolean equalsIdentity(java.lang.Object obj)
```
    Uses == for comparison of each value.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - iterator
```
public java.util.Iterator<IntMap.Entry<V>> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<IntMap.Entry<V>>
  - entries
```
public IntMap.Entries<V> entries()
```
  - values
```
public IntMap.Values<V> values()
```
  - keys
```
public IntMap.Keys keys()
```

Class IntMap<V>

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

IntMap

IntMap

IntMap

IntMap

Method Detail

place

put

putAll

get

get

remove

notEmpty

isEmpty

shrink

clear

clear

containsValue

containsKey

findKey

ensureCapacity

hashCode

equals

equalsIdentity

toString

iterator

entries

values

keys