at.mjst.lib.java.geometry.collections

Class HashTreeKdMap<DataType>

java.lang.Object

at.mjst.lib.java.geometry.collections.HashTreeKdMap<DataType>

All Implemented Interfaces:

KdMap<DataType>, java.lang.Iterable<DataType>

public class HashTreeKdMap<DataType>
extends java.lang.Object
implements KdMap<DataType>

Stores objects of type DataType identified by KdPoint KdPoint. Designed to speed up finding these objects by their corresponding coordinates using a tree managed by a HashMap for each coordinate-axis. The method add(KdPoint, Object) may be a bit slow. KdPoint.getDimensionCount() must fit dimensionCount specified for this map!

Since:

2016-05-31

Method Summary

Modifier and Type	Method and Description
void	add(KdPoint key, DataType data) Adds an item to the map.
void	clear() Destroys all entries within this map by recreating nodes and indices.
boolean	containsKey(KdPoint key) Checks, if a specific KdPoint does exist.
DataType	get(KdPoint key) Returns an object of Type DataType identified by key.
int	getSize()
java.util.Iterator<DataType>	iterator() Returns an iterator over elements of type DataType.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

getSize

public int getSize()

Specified by:

getSize in interface KdMap<DataType>

Returns:

current count of entries within this map.

add

public void add(KdPoint key,
                DataType data)

Description copied from interface: KdMap

Adds an item to the map. A key with same offsets cannot be added twice!

Specified by:

add in interface KdMap<DataType>

Parameters:

key - KdPoint to identify the new entry.

data - Object of Type DataType.

containsKey

public boolean containsKey(KdPoint key)

Description copied from interface: KdMap

Checks, if a specific KdPoint does exist.

Specified by:

containsKey in interface KdMap<DataType>

Parameters:

key - The KdPoint being asked for.

Returns:

True, if stored in map, false otherwise.

get

public DataType get(KdPoint key)

Description copied from interface: KdMap

Returns an object of Type DataType identified by key.

Specified by:

get in interface KdMap<DataType>

Parameters:

key - The KdPoint being asked for.

Returns:

Object formerly added by method KdMap.add(KdPoint, Object).

clear

public void clear()

Description copied from interface: KdMap

Destroys all entries within this map by recreating nodes and indices.

Specified by:

clear in interface KdMap<DataType>

iterator

public java.util.Iterator<DataType> iterator()

Returns an iterator over elements of type DataType.

Specified by:

iterator in interface java.lang.Iterable<DataType>

Returns:

an Iterator.