Class KDSpatialIndex<T>

A local KD key-value store

Type Parameters

T extends Properties = Properties

Implements

KDStore<T>

Index

Constructors

Accessors

Methods

[iterator] close get getRange push sort values

Constructors

constructor

new KDSpatialIndex<T extends Properties = Properties>(
nodeSize?: number,
): KDSpatialIndex<T>
Type Parameters
- T extends Properties = Properties
Parameters
- nodeSize: number = 64
  the size of each kd-tree node
Returns KDSpatialIndex<T>

Accessors

length

get length(): number
Returns number
the length of the store

Implementation of KDStore.length

Methods

[iterator]

"[iterator]"(): Generator<VectorPoint<T>>
iterate through the values

Returns Generator<VectorPoint<T>>
an iterator

Implementation of KDStore.[iterator]

close

close(): void
Closes the store

Returns void
Implementation of KDStore.close

get

get(index: number): VectorPoint<T>
Get a value at index
Parameters
- index: number
  the position in the store to get the value from
Returns VectorPoint<T>
the value

Implementation of KDStore.get

getRange

getRange(indexStart: number, indexEnd: number): VectorPoint<T>[]
Get a range of values within an index range
Parameters
- indexStart: number
  the start index
- indexEnd: number
  the end index
Returns VectorPoint<T>[]
the values

Implementation of KDStore.getRange

push

push(value: VectorPoint<T>): void
Push a value into the store
Parameters
- value: VectorPoint<T>
  the value to store
Returns void
Implementation of KDStore.push

sort

sort(): void
Sort the store in place

Returns void
Implementation of KDStore.sort

values

values(): Generator<VectorPoint<T>>
iterate through the values

Returns Generator<VectorPoint<T>>
Yields
an iterator

Implementation of KDStore.values