Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	IntIntMap.Entries
public static class	IntIntMap.Entry
public static class	IntIntMap.Keys
private static class	IntIntMap.MapIterator
public static class	IntIntMap.Values

Field Summary

Modifier and Type	Field and Description
private transient IntIntMap.Entries	entries1
private transient IntIntMap.Entries	entries2
pack-priv boolean	hasZeroValue
private transient IntIntMap.Keys	keys1
private transient IntIntMap.Keys	keys2
pack-priv int[]	keyTable
private final float	loadFactor
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`).
public int	size
private int	threshold
private transient IntIntMap.Values	values1
private transient IntIntMap.Values	values2
pack-priv int[]	valueTable
pack-priv int	zeroValue

Constructor Summary

Access	Constructor and Description
public	IntIntMap() Creates a new map with an initial capacity of 51 and a load factor of 0.8.
public	IntIntMap(int The backing array size is initialCapacity / loadFactor, increased to the next power of two. initialCapacity) Creates a new map with a load factor of 0.8.
public	IntIntMap(int The backing array size is initialCapacity / loadFactor, increased to the next power of two. initialCapacity, float loadFactor) Creates a new map with the specified initial capacity and load factor.
public	IntIntMap(IntIntMap map) Creates a new map identical to the specified map.

Method Summary

Modifier and Type	Method and Description
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.
public void	clear()
public boolean	containsKey(int key)
public boolean	containsValue(int value) Returns true if the specified value is in the map.
public void	ensureCapacity(int additionalCapacity) Increases the size of the backing array to accommodate the specified number of additional items / loadFactor.
public IntIntMap.Entries	entries() Returns an iterator for the entries in the map.
public boolean	equals(Object obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	findKey(int value, int notFound) Returns the key for the specified value, or null if it is not in the map.
public int	get(int key, int defaultValue)
public int	getAndIncrement(int key, int defaultValue, int increment) Returns the key's current value and increments the stored value.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isEmpty() Returns true if the map is empty.
public Iterator<IntIntMap.Entry>	iterator() Implements java.lang.Iterable.iterator. Returns an iterator over elements of type `T`.
public IntIntMap.Keys	keys() Returns an iterator for the keys in the map.
private int	locateKey(int key) Returns the index of the key if already present, else -(index + 1) for the next empty index.
public 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`.
public void	put(int key, int value)
public int	put(int key, int value, int defaultValue) Returns the old value associated with the specified key, or the specified default value.
public void	putAll(IntIntMap map)
public void	putMissing(int key, int value)
public int	putMissing(int key, int value, int defaultValue)
private void	putResize(int key, int value) Skips checks for existing keys, doesn't increment size, doesn't need to handle key 0.
public int	remove(int key, int defaultValue) Returns the value for the removed key, or the default value if the key is not in the map.
private void	resize(int newSize)
public void	shrink(int maximumCapacity) Reduces the size of the backing arrays to be the specified capacity / locateKey, or less.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public IntIntMap.Values	values() Returns an iterator for the values in the map.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

entries1	back to summary
private transient IntIntMap.Entries entries1

entries2	back to summary
private transient IntIntMap.Entries entries2

hasZeroValue	back to summary
pack-priv boolean hasZeroValue

keys1	back to summary
private transient IntIntMap.Keys keys1

keys2	back to summary
private transient IntIntMap.Keys keys2

keyTable	back to summary
pack-priv int[] keyTable

loadFactor	back to summary
private final float loadFactor

mask	back to summary
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 overridden, this can be used instead of `shift` to isolate usable bits of a hash.

shift back to summary

shift	back to summary
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.

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.

size	back to summary
public int size

threshold	back to summary
private int threshold

values1	back to summary
private transient IntIntMap.Values values1

values2	back to summary
private transient IntIntMap.Values values2

valueTable	back to summary
pack-priv int[] valueTable

zeroValue	back to summary
pack-priv int zeroValue

Constructor Detail

IntIntMap	back to summary
public IntIntMap() Creates a new map with an initial capacity of 51 and a load factor of 0.8.

IntIntMap	back to summary
public IntIntMap(int initialCapacity) Creates a new map with a load factor of 0.8. Parameters initialCapacity:int The backing array size is initialCapacity / loadFactor, increased to the next power of two.

IntIntMap

back to summary

public IntIntMap(int initialCapacity)

Creates a new map with a load factor of 0.8.

Parameters

initialCapacity:int: The backing array size is initialCapacity / loadFactor, increased to the next power of two.

IntIntMap	back to summary
public IntIntMap(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:int The backing array size is initialCapacity / loadFactor, increased to the next power of two.

IntIntMap

back to summary

public IntIntMap(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:int: The backing array size is initialCapacity / loadFactor, increased to the next power of two.

IntIntMap	back to summary
public IntIntMap(IntIntMap map) Creates a new map identical to the specified map.

Method Detail

clear	back to summary
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	back to summary
public void clear()

containsKey	back to summary
public boolean containsKey(int key)

containsValue	back to summary
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.

ensureCapacity	back to summary
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.

entries back to summary

entries	back to summary
public IntIntMap.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 `Entries` constructor for nested or multithreaded iteration.

public IntIntMap.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 Entries constructor for nested or multithreaded iteration.

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

findKey	back to summary
public int findKey(int value, int 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.

get	back to summary
public int get(int key, int defaultValue)

getAndIncrement	back to summary
public int getAndIncrement(int key, int defaultValue, int increment) Returns the key's current value and increments the stored value. If the key is not in the map, defaultValue + increment is put into the map and defaultValue is returned.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

isEmpty	back to summary
public boolean isEmpty() Returns true if the map is empty.

iterator back to summary

iterator	back to summary
public Iterator<IntIntMap.Entry> iterator() Implements java.lang.Iterable.iterator. Doc from java.lang.Iterable.iterator. Returns an iterator over elements of type `T`.

public Iterator<IntIntMap.Entry> iterator()

Implements java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

keys back to summary

keys	back to summary
public IntIntMap.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 `Entries` constructor for nested or multithreaded iteration.

public IntIntMap.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 Entries constructor for nested or multithreaded iteration.

locateKey	back to summary
private int locateKey(int key) Returns the index of the key if already present, else -(index + 1) for the next empty index.

notEmpty	back to summary
public boolean notEmpty() Returns true if the map has one or more items.

place back to summary

place	back to summary
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 overridden 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.

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 overridden 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.

put	back to summary
public void put(int key, int value)

put	back to summary
public int put(int key, int value, int defaultValue) Returns the old value associated with the specified key, or the specified default value.

putAll	back to summary
public void putAll(IntIntMap map)

putMissing	back to summary
public void putMissing(int key, int value)

putMissing	back to summary
public int putMissing(int key, int value, int defaultValue)

putResize	back to summary
private void putResize(int key, int value) Skips checks for existing keys, doesn't increment size, doesn't need to handle key 0.

remove	back to summary
public int remove(int key, int defaultValue) Returns the value for the removed key, or the default value if the key is not in the map.

resize	back to summary
private void resize(int newSize)

shrink	back to summary
public void shrink(int maximumCapacity) Reduces the size of the backing arrays to be the specified capacity / locateKey, 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.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned.

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

values back to summary

public IntIntMap.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 Entries constructor for nested or multithreaded iteration.

com.badlogic.gdx.utils back to summary

public Class IntIntMap.Entries

Class Inheritance

extends MapIterator
implements Iterable<IntIntMap.Entry>, Iterator<IntIntMap.Entry>

java.lang.Object
com.badlogic.gdx.utils.IntIntMap.MapIterator
com.badlogic.gdx.utils.IntIntMap.Entries

All Implemented Interfaces

java.util.Iterator, java.lang.Iterable

Field Summary

Modifier and Type	Field and Description
private final IntIntMap.Entry	entry

Inherited from com.badlogic.gdx.utils.IntIntMap.MapIterator:: currentIndex hasNext INDEX_ZERO map nextIndex valid

Constructor Summary

Access	Constructor and Description
public	Entries(IntIntMap map)

Method Summary

Modifier and Type	Method and Description
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public Iterator<IntIntMap.Entry>	iterator() Implements java.lang.Iterable.iterator. Returns an iterator over elements of type `T`.
public IntIntMap.Entry	next() Implements java.util.Iterator.next. Note the same entry instance is returned each time this method is called.

Inherited from com.badlogic.gdx.utils.IntIntMap.MapIterator:: findNextIndex remove reset

Field Detail

entry	back to summary
private final IntIntMap.Entry entry

Constructor Detail

Entries	back to summary
public Entries(IntIntMap map)

Method Detail

hasNext back to summary

public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

iterator back to summary

public Iterator<IntIntMap.Entry> iterator()

Implements java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

back to summary

public IntIntMap.Entry next()

Implements java.util.Iterator.next.

Note the same entry instance is returned each time this method is called.

com.badlogic.gdx.utils back to summary

public Class IntIntMap.Entry

Class Inheritance

extends Object

java.lang.Object
com.badlogic.gdx.utils.IntIntMap.Entry

Field Summary

Modifier and Type	Field and Description
public int	key
public int	value

Constructor Summary

Access	Constructor and Description
public	Entry()

Method Summary

Modifier and Type	Method and Description
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

key	back to summary
public int key

value	back to summary
public int value

Constructor Detail

Entry	back to summary
public Entry()

Method Detail

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

com.badlogic.gdx.utils back to summary

public Class IntIntMap.Keys

Class Inheritance

extends MapIterator

java.lang.Object
com.badlogic.gdx.utils.IntIntMap.MapIterator
com.badlogic.gdx.utils.IntIntMap.Keys

Field Summary

Inherited from com.badlogic.gdx.utils.IntIntMap.MapIterator:: currentIndex hasNext INDEX_ZERO map nextIndex valid

Constructor Summary

Access	Constructor and Description
public	Keys(IntIntMap map)

Method Summary

Modifier and Type	Method and Description
public int	next()
public IntArray	toArray() Returns a new array containing the remaining keys.
public IntArray	toArray(IntArray array) Adds the remaining values to the specified array.

Inherited from com.badlogic.gdx.utils.IntIntMap.MapIterator:: findNextIndex remove reset

Constructor Detail

Keys	back to summary
public Keys(IntIntMap map)

Method Detail

next	back to summary
public int next()

toArray	back to summary
public IntArray toArray() Returns a new array containing the remaining keys.

toArray	back to summary
public IntArray toArray(IntArray array) Adds the remaining values to the specified array.

com.badlogic.gdx.utils back to summary

private Class IntIntMap.MapIterator

Class Inheritance

extends Object

java.lang.Object
com.badlogic.gdx.utils.IntIntMap.MapIterator

Known Direct Subclasses

com.badlogic.gdx.utils.IntIntMap.Entries, com.badlogic.gdx.utils.IntIntMap.Values, com.badlogic.gdx.utils.IntIntMap.Keys

Field Summary

Modifier and Type	Field and Description
pack-priv int	currentIndex
public boolean	hasNext
private static final int	INDEX_ILLEGAL
pack-priv static final int	INDEX_ZERO
pack-priv final IntIntMap	map
pack-priv int	nextIndex
pack-priv boolean	valid

Constructor Summary

Access	Constructor and Description
public	MapIterator(IntIntMap map)

Method Summary

Modifier and Type	Method and Description
pack-priv void	findNextIndex()
public void	remove()
public void	reset()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

currentIndex	back to summary
pack-priv int currentIndex

hasNext	back to summary
public boolean hasNext

INDEX_ILLEGAL	back to summary
private static final int INDEX_ILLEGAL

INDEX_ZERO	back to summary
pack-priv static final int INDEX_ZERO

map	back to summary
pack-priv final IntIntMap map

nextIndex	back to summary
pack-priv int nextIndex

valid	back to summary
pack-priv boolean valid

Constructor Detail

MapIterator	back to summary
public MapIterator(IntIntMap map)

Method Detail

findNextIndex	back to summary
pack-priv void findNextIndex()

remove	back to summary
public void remove()

reset	back to summary
public void reset()

com.badlogic.gdx.utils back to summary

public Class IntIntMap.Values

Class Inheritance

extends MapIterator

java.lang.Object
com.badlogic.gdx.utils.IntIntMap.MapIterator
com.badlogic.gdx.utils.IntIntMap.Values

Field Summary

Inherited from com.badlogic.gdx.utils.IntIntMap.MapIterator:: currentIndex hasNext INDEX_ZERO map nextIndex valid

Constructor Summary

Access	Constructor and Description
public	Values(IntIntMap map)

Method Summary

Modifier and Type	Method and Description
public boolean	hasNext()
public IntIntMap.Values	iterator()
public int	next()
public IntArray	toArray() Returns a new array containing the remaining values.
public IntArray	toArray(IntArray array) Adds the remaining values to the specified array.

Inherited from com.badlogic.gdx.utils.IntIntMap.MapIterator:: findNextIndex remove reset

Constructor Detail

Values	back to summary
public Values(IntIntMap map)

Method Detail

hasNext	back to summary
public boolean hasNext()

iterator	back to summary
public IntIntMap.Values iterator()

next	back to summary
public int next()

toArray	back to summary
public IntArray toArray() Returns a new array containing the remaining values.

toArray	back to summary
public IntArray toArray(IntArray array) Adds the remaining values to the specified array.