at.mjst.lib.java.geometry.collections

Interface KdMap<DataType>

All Superinterfaces:

java.lang.Iterable<DataType>

All Known Implementing Classes:

HashTreeKdMap

public interface KdMap<DataType>
extends java.lang.Iterable<DataType>

Stores objects of type DataType identified by KdPoint.

Since:

2016-06-04

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()

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

add

void add(KdPoint key,
         DataType data)

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

Parameters:

key - KdPoint to identify the new entry.

data - Object of Type DataType.

containsKey

boolean containsKey(KdPoint key)

Checks, if a specific KdPoint does exist.

Parameters:

key - The KdPoint being asked for.

Returns:

True, if stored in map, false otherwise.

get

DataType get(KdPoint key)

Returns an object of Type DataType identified by key.

Parameters:

key - The KdPoint being asked for.

Returns:

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

getSize

int getSize()

Returns:

current count of entries within this map.

clear

void clear()

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