Package etomica.util.collections

Class IndexMap<V>

java.lang.Object

etomica.util.collections.IndexMap<V>

Type Parameters:

V - the type of value contained in this map.

All Implemented Interfaces:

java.util.Map<java.lang.Integer,V>

public final class IndexMap<V>
extends java.lang.Object
implements java.util.Map<java.lang.Integer,V>

An specialized implementation of Map which is designed for mapping an index to a value. It is backed by an array but allows inserting out of index order without having to manage array resizing manually.

This should not be used as a general int-keyed map as the backing array will take space up to the largest key. Use this when you have an expected maximum index (but not necessarily known or constant) that you need to sporadically fill mappings up to.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K extends java.lang.Object,V extends java.lang.Object>

Constructor Summary

Constructors

Constructor	Description
IndexMap()	Creates a new map with the default initial capacity of 10 and default reservoir size of 30.
IndexMap(int initialCapacity)	Creates a new map with the given initial capacity and default reservoir size of 30.
IndexMap(int initialCapacity, int reservoirSize)	Creates a new map with the given initial capacity and reservoir size.

Method Summary

Modifier and Type	Method	Description
void	clear()
boolean	containsKey(int key)
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
java.util.Set<java.util.Map.Entry<java.lang.Integer,V>>	entrySet()	Do NOT use this.
V	get(int key)
V	get(java.lang.Object key)
boolean	isEmpty()
java.util.Set<java.lang.Integer>	keySet()
V	put(int key, V value)
V	put(java.lang.Integer key, V value)
void	putAll(java.util.Map<? extends java.lang.Integer,? extends V> m)
V	remove(int key)
V	remove(java.lang.Object key)
int	size()
java.util.Collection<V>	values()

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, entry, equals, forEach, getOrDefault, hashCode, merge, of, of, of, of, of, of, of, of, of, of, of, ofEntries, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IndexMap

public IndexMap()

Creates a new map with the default initial capacity of 10 and default reservoir size of 30.

IndexMap

public IndexMap(int initialCapacity)

Creates a new map with the given initial capacity and default reservoir size of 30.

Parameters:

initialCapacity - the base capacity to start with.

IndexMap

public IndexMap(int initialCapacity,
                int reservoirSize)

Creates a new map with the given initial capacity and reservoir size. The backing array will be of size initialCapacity + reservoirSize, and keys up to that value can be added without the array being resized.

Parameters:

initialCapacity - the base capacity to start with.

reservoirSize - the amount of padding to be included in the backing array.

Method Detail

size

public int size()

Specified by:

size in interface java.util.Map<java.lang.Integer,V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<java.lang.Integer,V>

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map<java.lang.Integer,V>

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map<java.lang.Integer,V>

get

public V get(java.lang.Object key)

Specified by:

get in interface java.util.Map<java.lang.Integer,V>

put

public V put(java.lang.Integer key,
             V value)

Specified by:

put in interface java.util.Map<java.lang.Integer,V>

remove

public V remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<java.lang.Integer,V>

putAll

public void putAll(java.util.Map<? extends java.lang.Integer,? extends V> m)

Specified by:

putAll in interface java.util.Map<java.lang.Integer,V>

clear

public void clear()

Specified by:

clear in interface java.util.Map<java.lang.Integer,V>

keySet

public java.util.Set<java.lang.Integer> keySet()

Specified by:

keySet in interface java.util.Map<java.lang.Integer,V>

values

public java.util.Collection<V> values()

Specified by:

values in interface java.util.Map<java.lang.Integer,V>

entrySet

public java.util.Set<java.util.Map.Entry<java.lang.Integer,V>> entrySet()

Do NOT use this. It is intended for the IDE debugger only. This will create a new HashMap for each invocation and add all values.

Specified by:

entrySet in interface java.util.Map<java.lang.Integer,V>

containsKey

public boolean containsKey(int key)

get

public V get(int key)

put

public V put(int key,
             V value)

remove

public V remove(int key)