com.xilinx.rapidwright.device.helper

Class HashPool<E>

Object

AbstractMap<K,V>

HashMap<Integer,ArrayList<E>>

com.xilinx.rapidwright.device.helper.HashPool<E>

Type Parameters:

E - The type of object to use.

All Implemented Interfaces:

Serializable, Cloneable, Map<Integer,ArrayList<E>>

public class HashPool<E>
extends HashMap<Integer,ArrayList<E>>

This class is a special data structure used for Xilinx FPGA devices to help reduce memory footprint of objects. It keeps exactly one copy of an object of type E and maintains a unique integer enumeration of each object. It depends on the type E's equals() and hashCode() function to determine uniqueness.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
HashPool()

Method Summary

Modifier and Type	Method and Description
E	add(E obj) Adds the object to the pool if an identical copy doesn't already exist.
boolean	contains(E obj) Checks the HashPool if it contains an equal object to obj as defined by the equals() method.
E	find(E obj) Gets the identical object in the HashPool that is equal by definition of the equals() method.
HashMap<E,ArrayList<Integer>>	getEnumerationMap()
ArrayList<E>	getEnumerations()
Integer	getEnumerationValue(E obj) Gets the Integer enumeration of the object based on the HashPool.
void	setEnumerationMap(HashMap<E,ArrayList<Integer>> enumerationMap)
void	setEnumerations(ArrayList<E> enumerations)

Methods inherited from class HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class AbstractMap

equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Map

equals, hashCode

Constructor Detail

HashPool

public HashPool()

Method Detail

getEnumerationValue

public Integer getEnumerationValue(E obj)

Gets the Integer enumeration of the object based on the HashPool.

Parameters:

obj - The object to get an enumeration value for.

Returns:

The enumeration value of the object obj, or -1 if none exists.

add

public E add(E obj)

Adds the object to the pool if an identical copy doesn't already exist.

Parameters:

obj - The object to be added

Returns:

The unique object contained in the HashPool

contains

public boolean contains(E obj)

Checks the HashPool if it contains an equal object to obj as defined by the equals() method.

Parameters:

obj - The object to check for.

Returns:

True if the HashPool contains the object, false otherwise.

find

public E find(E obj)

Gets the identical object in the HashPool that is equal by definition of the equals() method. Returns null if no equivalent object exists in pool

Parameters:

obj - The object to find in the pool

Returns:

The object in the pool that is equal to obj, null otherwise.

getEnumerations

public ArrayList<E> getEnumerations()

Returns:

the enumerations

setEnumerations

public void setEnumerations(ArrayList<E> enumerations)

Parameters:

enumerations - the enumerations to set

getEnumerationMap

public HashMap<E,ArrayList<Integer>> getEnumerationMap()

Returns:

the enumerationMap

setEnumerationMap

public void setEnumerationMap(HashMap<E,ArrayList<Integer>> enumerationMap)

Parameters:

enumerationMap - the enumerationMap to set