Class KdTreeMap<K, V>

https://en.wikipedia.org/wiki/K-d_tree

Partially based on: https://github.com/ubilabs/kd-tree-javascript

Type parameters

K: ReadonlyVec
V

Hierarchy

KdTreeMap

Implements

ICopy<KdTreeMap<K, V>>
IEmpty<KdTreeMap<K, V>>
IRegionQuery<K, V, number>
ISpatialMap<K, V>

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new KdTreeMap<K, V>(dim: number, pairs?: Iterable<Pair<K, V>>): KdTreeMap<K, V>

- Defined in kd-tree-map.ts:50
Type parameters
- K: ArrayLike<number, K> & Iterable<number, K>
- V
Parameters
- dim: number
- Optional pairs: Iterable<Pair<K, V>>
Returns KdTreeMap<K, V>

Properties

Protected _size

_size: number

Readonly dim

dim: number

Protected root

root: MaybeKdNode<K, V>

Accessors

height

get height(): number

- Defined in kd-tree-map.ts:88
Returns number

ratio

get ratio(): number

- Defined in kd-tree-map.ts:92
Returns number

size

get size(): number

- Defined in kd-tree-map.ts:84
Returns number

Methods

[Symbol.iterator]

[Symbol.iterator](): Generator<Pair<K, V>, void, unknown>

- Defined in kd-tree-map.ts:58
Returns Generator<Pair<K, V>, void, unknown>

Protected buildTree

buildTree(points: Pair<K, V>[], depth: number, parent?: KdNode<K, V>): undefined | KdNode<K, V>

- Defined in kd-tree-map.ts:221
Parameters
- points: Pair<K, V>[]
- depth: number
- Optional parent: KdNode<K, V>
Returns undefined | KdNode<K, V>

clear

clear(): void

- Defined in kd-tree-map.ts:100
Returns void

copy

copy(): KdTreeMap<K, V>

- Defined in kd-tree-map.ts:96
Returns KdTreeMap<K, V>

Protected doSelect

doSelect<T>(q: K, f: Fn<KdNode<K, V>, T>, maxDist: number, maxNum?: number, acc?: T[]): T[]

- Defined in kd-tree-map.ts:191
Type parameters
- T
Parameters
- q: K
- f: Fn<KdNode<K, V>, T>
- maxDist: number
- maxNum: number = 1
- acc: T[] = ...
Returns T[]

empty

empty(): KdTreeMap<K, V>

- Defined in kd-tree-map.ts:105
Returns KdTreeMap<K, V>

get

get(key: K, eps?: number): undefined | V

- Defined in kd-tree-map.ts:162
Parameters
- key: K
- eps: number = ...
Returns undefined | V

has

has(key: K, eps?: number): boolean

- Defined in kd-tree-map.ts:155
Parameters
- key: K
- eps: number = ...
Returns boolean

into

into(pairs: Iterable<Pair<K, V>>, eps?: number): boolean

- Defined in kd-tree-map.ts:141
Parameters
- pairs: Iterable<Pair<K, V>>
- eps: number = ...
Returns boolean

keys

keys(): Generator<K, void, unknown>

- Defined in kd-tree-map.ts:69
Returns Generator<K, void, unknown>

query

query(q: K, maxDist: number, limit?: number, acc?: Pair<K, V>[]): Pair<K, V>[]

- Defined in kd-tree-map.ts:174
Parameters
- q: K
- maxDist: number
- Optional limit: number
- Optional acc: Pair<K, V>[]
Returns Pair<K, V>[]

queryKeys

queryKeys(q: K, maxDist: number, limit?: number, acc?: K[]): K[]

- Defined in kd-tree-map.ts:183
Parameters
- q: K
- maxDist: number
- Optional limit: number
- Optional acc: K[]
Returns K[]

queryValues

queryValues(q: K, maxDist: number, limit?: number, acc?: V[]): V[]

- Defined in kd-tree-map.ts:187
Parameters
- q: K
- maxDist: number
- Optional limit: number
- Optional acc: V[]
Returns V[]

remove

remove(key: K): boolean

- Defined in kd-tree-map.ts:145
Parameters
- key: K
Returns boolean

set

set(key: K, val: V, eps?: number): boolean

- Defined in kd-tree-map.ts:109
Parameters
- key: K
- val: V
- eps: number = ...
Returns boolean

values

values(): IterableIterator<V>

- Defined in kd-tree-map.ts:80
Returns IterableIterator<V>

Generated using TypeDoc