Modifier and Type	Class and Description
public class	OpenIntToFieldHashMap.Iterator Iterator class for the map.

Field Summary

Modifier and Type	Field and Description
private transient int	count Modifications count.
private static final int	DEFAULT_EXPECTED_SIZE Default starting size.
private final Field<T>	field Field to which the elements belong.
protected static final byte	FREE Status indicator for free table entries.
protected static final byte	FULL Status indicator for full table entries.
private int[]	keys Keys table.
private static final float	LOAD_FACTOR Load factor for the map.
private int	mask Bit mask for hash values.
private final T	missingEntries Return value for missing entries.
private static final int	PERTURB_SHIFT Number of bits to perturb the index when probing for collision resolution.
protected static final byte	REMOVED Status indicator for removed table entries.
private static final int	RESIZE_MULTIPLIER Multiplier for size growth when map fills up.
private static final long	serialVersionUID Serializable version identifier.
private int	size Current size of the map.
private byte[]	states States table.
private T[]	values Values table.

Constructor Summary

Access	Constructor and Description
public	OpenIntToFieldHashMap(final Field<T> field to which the elements belong field) Build an empty map with default size and using zero for missing entries.
public	OpenIntToFieldHashMap(final Field<T> field to which the elements belong field, final T value to return when a missing entry is fetched missingEntries) Build an empty map with default size
public	OpenIntToFieldHashMap(final Field<T> field to which the elements belong field, final int expected number of elements in the map expectedSize) Build an empty map with specified size and using zero for missing entries.
public	OpenIntToFieldHashMap(final Field<T> field to which the elements belong field, final int expected number of elements in the map expectedSize, final T value to return when a missing entry is fetched missingEntries) Build an empty map with specified size.
public	OpenIntToFieldHashMap(final OpenIntToFieldHashMap<T> map to copy source) Copy constructor.

Method Summary

Modifier and Type	Method and Description
private T[]	Returns: a new array buildArray(final int size of the array to build length) Build an array of elements.
private static int	Returns: changed index changeIndexSign(final int initial index index) Change the index sign
private static int	Returns: capacity to use for the specified size computeCapacity(final int expected size of the map expectedSize) Compute the capacity needed for a given size.
public boolean	Returns: true if a value is associated with key containsKey(final int key to check key) Check if a value is associated with a key.
private boolean	Returns: true if an element is associated with key at index containsKey(final int key to check key, final int index to check index) Check if the tables contain an element associated with specified key at specified index.
private T	Returns: removed value doRemove(int index of the element to remove index) Remove an element at specified index.
private int	Returns: index at which key should be inserted findInsertionIndex(final int key to lookup key) Find the index at which a key should be inserted
private static int	Returns: index at which key should be inserted findInsertionIndex(final int[] keys table keys, final byte[] states table states, final int key to lookup key, final int bit mask for hash values mask) Find the index at which a key should be inserted
public T	Returns: data associated with the key get(final int key associated with the data key) Get the stored value associated with the given key
private void	growTable() Grow the tables.
private static int	Returns: hash value of the key hashOf(final int key to hash key) Compute the hash value of a key
public OpenIntToFieldHashMap<T>.Iterator	Returns: iterator over the map elements iterator() Get an iterator over map elements.
private static int	Returns: smallest power of two greater than the input value nextPowerOfTwo(final int input value i) Find the smallest power of two greater than the input value
private static int	Returns: perturbed hash perturb(final int initial hash hash) Perturb the hash for starting probing.
private static int	Returns: next probe probe(final int perturbed hash perturb, final int previous probe j) Compute next probe for collision resolution
public T	Returns: previous value associated with the key put(final int key to which value is associated key, final T value to put in the map value) Put a value associated with a key in the map.
private void	readObject(final ObjectInputStream input stream stream) Read a serialized object.
public T	Returns: removed value remove(final int key to which the value is associated key) Remove the value associated with a key.
private boolean	Returns: true if tables should grow shouldGrowTable() Check if tables should grow due to increased size.
public int	Returns: number of elements stored in the map size() Get the number of elements stored in the map.

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

Field Detail

count	back to summary
private transient int count Modifications count.

DEFAULT_EXPECTED_SIZE	back to summary
private static final int DEFAULT_EXPECTED_SIZE Default starting size. This must be a power of two for bit mask to work properly.

DEFAULT_EXPECTED_SIZE

back to summary

private static final int DEFAULT_EXPECTED_SIZE

Default starting size.

This must be a power of two for bit mask to work properly.

field	back to summary
private final Field<T> field Field to which the elements belong.

FREE	back to summary
protected static final byte FREE Status indicator for free table entries.

FULL	back to summary
protected static final byte FULL Status indicator for full table entries.

keys	back to summary
private int[] keys Keys table.

LOAD_FACTOR	back to summary
private static final float LOAD_FACTOR Load factor for the map.

mask	back to summary
private int mask Bit mask for hash values.

missingEntries	back to summary
private final T missingEntries Return value for missing entries.

PERTURB_SHIFT	back to summary
private static final int PERTURB_SHIFT Number of bits to perturb the index when probing for collision resolution.

REMOVED	back to summary
protected static final byte REMOVED Status indicator for removed table entries.

RESIZE_MULTIPLIER	back to summary
private static final int RESIZE_MULTIPLIER Multiplier for size growth when map fills up. This must be a power of two for bit mask to work properly.

RESIZE_MULTIPLIER

back to summary

private static final int RESIZE_MULTIPLIER

Multiplier for size growth when map fills up.

This must be a power of two for bit mask to work properly.

serialVersionUID	back to summary
private static final long serialVersionUID Serializable version identifier.

size	back to summary
private int size Current size of the map.

states	back to summary
private byte[] states States table.

values	back to summary
private T[] values Values table.

Constructor Detail

OpenIntToFieldHashMap	back to summary
public OpenIntToFieldHashMap(final Field<T> field) Build an empty map with default size and using zero for missing entries. Parameters field:Field<T> field to which the elements belong

OpenIntToFieldHashMap

back to summary

public OpenIntToFieldHashMap(final Field<T> field)

Build an empty map with default size and using zero for missing entries.

Parameters

field:Field<T>: field to which the elements belong

OpenIntToFieldHashMap	back to summary
public OpenIntToFieldHashMap(final Field<T> field, final T missingEntries) Build an empty map with default size Parameters field:Field<T> field to which the elements belong missingEntries:T value to return when a missing entry is fetched

OpenIntToFieldHashMap

back to summary

public OpenIntToFieldHashMap(final Field<T> field, final T missingEntries)

Build an empty map with default size

Parameters

field:Field<T>: field to which the elements belong
missingEntries:T: value to return when a missing entry is fetched

OpenIntToFieldHashMap	back to summary
public OpenIntToFieldHashMap(final Field<T> field, final int expectedSize) Build an empty map with specified size and using zero for missing entries. Parameters field:Field<T> field to which the elements belong expectedSize:int expected number of elements in the map

OpenIntToFieldHashMap

back to summary

public OpenIntToFieldHashMap(final Field<T> field, final int expectedSize)

Build an empty map with specified size and using zero for missing entries.

Parameters

field:Field<T>: field to which the elements belong
expectedSize:int: expected number of elements in the map

OpenIntToFieldHashMap	back to summary
public OpenIntToFieldHashMap(final Field<T> field, final int expectedSize, final T missingEntries) Build an empty map with specified size. Parameters field:Field<T> field to which the elements belong expectedSize:int expected number of elements in the map missingEntries:T value to return when a missing entry is fetched

OpenIntToFieldHashMap

back to summary

public OpenIntToFieldHashMap(final Field<T> field, final int expectedSize, final T missingEntries)

Build an empty map with specified size.

Parameters

field:Field<T>: field to which the elements belong
expectedSize:int: expected number of elements in the map
missingEntries:T: value to return when a missing entry is fetched

OpenIntToFieldHashMap	back to summary
public OpenIntToFieldHashMap(final OpenIntToFieldHashMap<T> source) Copy constructor. Parameters source:OpenIntToFieldHashMap<T> map to copy

OpenIntToFieldHashMap

back to summary

public OpenIntToFieldHashMap(final OpenIntToFieldHashMap<T> source)

Copy constructor.

Parameters

source:OpenIntToFieldHashMap<T>: map to copy

Method Detail

buildArray	back to summary
private T[] buildArray(final int length) Build an array of elements. Parameters length:int size of the array to build Returns:T[] a new array Annotations @SuppressWarnings:unchecked

buildArray

back to summary

private T[] buildArray(final int length)

Build an array of elements.

Parameters

length:int: size of the array to build

Returns:T[]

a new array

Annotations

@SuppressWarnings:unchecked

changeIndexSign	back to summary
private static int changeIndexSign(final int index) Change the index sign Parameters index:int initial index Returns:int changed index

changeIndexSign

back to summary

private static int changeIndexSign(final int index)

Change the index sign

Parameters

index:int: initial index

Returns:int

changed index

computeCapacity	back to summary
private static int computeCapacity(final int expectedSize) Compute the capacity needed for a given size. Parameters expectedSize:int expected size of the map Returns:int capacity to use for the specified size

computeCapacity

back to summary

private static int computeCapacity(final int expectedSize)

Compute the capacity needed for a given size.

Parameters

expectedSize:int: expected size of the map

Returns:int

capacity to use for the specified size

containsKey	back to summary
public boolean containsKey(final int key) Check if a value is associated with a key. Parameters key:int key to check Returns:boolean true if a value is associated with key

containsKey

back to summary

public boolean containsKey(final int key)

Check if a value is associated with a key.

Parameters

key:int: key to check

Returns:boolean

true if a value is associated with key

containsKey	back to summary
private boolean containsKey(final int key, final int index) Check if the tables contain an element associated with specified key at specified index. Parameters key:int key to check index:int index to check Returns:boolean true if an element is associated with key at index

containsKey

back to summary

private boolean containsKey(final int key, final int index)

Check if the tables contain an element associated with specified key at specified index.

Parameters

key:int: key to check
index:int: index to check

Returns:boolean

true if an element is associated with key at index

doRemove	back to summary
private T doRemove(int index) Remove an element at specified index. Parameters index:int index of the element to remove Returns:T removed value

doRemove

back to summary

private T doRemove(int index)

Remove an element at specified index.

Parameters

index:int: index of the element to remove

Returns:T

removed value

findInsertionIndex	back to summary
private int findInsertionIndex(final int key) Find the index at which a key should be inserted Parameters key:int key to lookup Returns:int index at which key should be inserted

findInsertionIndex

back to summary

private int findInsertionIndex(final int key)

Find the index at which a key should be inserted

Parameters

key:int: key to lookup

Returns:int

index at which key should be inserted

findInsertionIndex	back to summary
private static int findInsertionIndex(final int[] keys, final byte[] states, final int key, final int mask) Find the index at which a key should be inserted Parameters keys:int[] keys table states:byte[] states table key:int key to lookup mask:int bit mask for hash values Returns:int index at which key should be inserted

findInsertionIndex

back to summary

private static int findInsertionIndex(final int[] keys, final byte[] states, final int key, final int mask)

Find the index at which a key should be inserted

Parameters

keys:int[]: keys table
states:byte[]: states table
key:int: key to lookup
mask:int: bit mask for hash values

Returns:int

index at which key should be inserted

get	back to summary
public T get(final int key) Get the stored value associated with the given key Parameters key:int key associated with the data Returns:T data associated with the key

get

back to summary

public T get(final int key)

Get the stored value associated with the given key

Parameters

key:int: key associated with the data

Returns:T

data associated with the key

growTable	back to summary
private void growTable() Grow the tables.

hashOf	back to summary
private static int hashOf(final int key) Compute the hash value of a key Parameters key:int key to hash Returns:int hash value of the key

hashOf

back to summary

private static int hashOf(final int key)

Compute the hash value of a key

Parameters

key:int: key to hash

Returns:int

hash value of the key

iterator back to summary

iterator	back to summary
public OpenIntToFieldHashMap<T>.Iterator iterator() Get an iterator over map elements. The specialized iterators returned are fail-fast: they throw a `ConcurrentModificationException` when they detect the map has been modified during iteration. Returns:OpenIntToFieldHashMap<T>.Iterator iterator over the map elements

public OpenIntToFieldHashMap<T>.Iterator iterator()

Get an iterator over map elements.

The specialized iterators returned are fail-fast: they throw a ConcurrentModificationException when they detect the map has been modified during iteration.

Returns:OpenIntToFieldHashMap<T>.Iterator: iterator over the map elements

nextPowerOfTwo	back to summary
private static int nextPowerOfTwo(final int i) Find the smallest power of two greater than the input value Parameters i:int input value Returns:int smallest power of two greater than the input value

nextPowerOfTwo

back to summary

private static int nextPowerOfTwo(final int i)

Find the smallest power of two greater than the input value

Parameters

i:int: input value

Returns:int

smallest power of two greater than the input value

perturb	back to summary
private static int perturb(final int hash) Perturb the hash for starting probing. Parameters hash:int initial hash Returns:int perturbed hash

perturb

back to summary

private static int perturb(final int hash)

Perturb the hash for starting probing.

Parameters

hash:int: initial hash

Returns:int

perturbed hash

probe	back to summary
private static int probe(final int perturb, final int j) Compute next probe for collision resolution Parameters perturb:int perturbed hash j:int previous probe Returns:int next probe

probe

back to summary

private static int probe(final int perturb, final int j)

Compute next probe for collision resolution

Parameters

perturb:int: perturbed hash
j:int: previous probe

Returns:int

next probe

put	back to summary
public T put(final int key, final T value) Put a value associated with a key in the map. Parameters key:int key to which value is associated value:T value to put in the map Returns:T previous value associated with the key

put

back to summary

public T put(final int key, final T value)

Put a value associated with a key in the map.

Parameters

key:int: key to which value is associated
value:T: value to put in the map

Returns:T

previous value associated with the key

readObject	back to summary
private void readObject(final ObjectInputStream stream) throws IOException, ClassNotFoundException Read a serialized object. Parameters stream:ObjectInputStream input stream Exceptions IOException: if object cannot be read ClassNotFoundException: if the class corresponding to the serialized object cannot be found

readObject

back to summary

private void readObject(final ObjectInputStream stream) throws IOException, ClassNotFoundException

Read a serialized object.

Parameters

stream:ObjectInputStream: input stream

Exceptions

IOException:: if object cannot be read
ClassNotFoundException:: if the class corresponding to the serialized object cannot be found

remove	back to summary
public T remove(final int key) Remove the value associated with a key. Parameters key:int key to which the value is associated Returns:T removed value

remove

back to summary

public T remove(final int key)

Remove the value associated with a key.

Parameters

key:int: key to which the value is associated

Returns:T

removed value

shouldGrowTable	back to summary
private boolean shouldGrowTable() Check if tables should grow due to increased size. Returns:boolean true if tables should grow

shouldGrowTable

back to summary

private boolean shouldGrowTable()

Check if tables should grow due to increased size.

Returns:boolean: true if tables should grow

size	back to summary
public int size() Get the number of elements stored in the map. Returns:int number of elements stored in the map

size

back to summary

public int size()

Get the number of elements stored in the map.

Returns:int: number of elements stored in the map

org.apache.commons.math3.util back to summary

public Class OpenIntToFieldHashMap.Iterator

Class Inheritance

extends Object

java.lang.Object
org.apache.commons.math3.util.OpenIntToFieldHashMap.Iterator

Iterator class for the map.

Field Summary

Modifier and Type	Field and Description
private int	current Index of current element.
private int	next Index of next element.
private final int	referenceCount Reference modification count.

Constructor Summary

Access	Constructor and Description
private	Iterator() Simple constructor.

Method Summary

Modifier and Type	Method and Description
public void	advance() Advance iterator one step further.
public boolean	Returns: true if there is a next element hasNext() Check if there is a next element in the map.
public int	Returns: key of current entry key() Get the key of current entry.
public T	Returns: value of current entry value() Get the value of current entry.