Class AvlTreeIndex<T>

LokiDB AVL Balanced Binary Tree Index implementation. To support duplicates, we use siblings (array) in tree nodes. Basic AVL components guided by William Fiset tutorials at : https://github.com/williamfiset/data-structures/blob/master/com/williamfiset/datastructures/balancedtree/AVLTreeRecursive.java https://www.youtube.com/watch?v=g4y2h70D6Nk&list=PLDV1Zeh2NRsD06x59fxczdWLhDDszUHKt

Type parameters

T

Hierarchy

AvlTreeIndex

Implements

IRangedIndex<T>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AvlTreeIndex(name: string, comparator: ILokiComparer<T>): AvlTreeIndex

- Defined in loki/src/avl_index.ts:38
Initializes index with property name and a comparer function.

Parameters
- name: string
- comparator: ILokiComparer<T>
Returns AvlTreeIndex

Properties

apex

apex: number | null = null

comparator

comparator: ILokiComparer<T>

name

name: string

nodes

nodes: ITreeNodeHash<T>

Methods

backup

backup(): AvlTreeIndex<T>

Implementation of IRangedIndex.backup
- Defined in loki/src/avl_index.ts:48
Returns AvlTreeIndex<T>

getValuesAsTree

getValuesAsTree(node?: TreeNode<T>): any

- Defined in loki/src/avl_index.ts:312
Diagnostic method for examining tree contents and structure

Parameters
- Optional node: TreeNode<T>
Returns any

insert

insert(id: number, val: T): void

Implementation of IRangedIndex.insert
- Defined in loki/src/avl_index.ts:67
Used for inserting a new value into the BinaryTreeIndex

Parameters
- id: number
  
  Unique Id (such as $loki) to associate with value
- val: T
  
  Value to be indexed and inserted into binary tree
Returns void

insertNode

insertNode(current: TreeNode<T>, node: TreeNode<T>): number

- Defined in loki/src/avl_index.ts:96
Recursively inserts a treenode and re-balances if needed.

Parameters
- current: TreeNode<T>
- node: TreeNode<T>
Returns number

rangeRequest

rangeRequest(range?: IRangedIndexRequest<T>): number[]

Implementation of IRangedIndex.rangeRequest
- Defined in loki/src/avl_index.ts:645
Interface method to support ranged queries. Results sorted by index property.

Parameters
- Optional range: IRangedIndexRequest<T>
  
  Options for ranged request.
Returns number[]

remove

remove(id: number): void

Implementation of IRangedIndex.remove
- Defined in loki/src/avl_index.ts:348
Removes a value from the binary tree index

Parameters
- id: number
Returns void

restore

restore(tree: AvlTreeIndex<T>): void

- Defined in loki/src/avl_index.ts:55
Parameters
- tree: AvlTreeIndex<T>
Returns void

update

update(id: number, val: T): void

Implementation of IRangedIndex.update
- Defined in loki/src/avl_index.ts:333
Updates a value, possibly relocating it, within binary tree

Parameters
- id: number
  
  Unique Id (such as $loki) to associate with value
- val: T
  
  New value to be indexed within binary tree
Returns void

validateIndex

validateIndex(): boolean

Implementation of IRangedIndex.validateIndex
- Defined in loki/src/avl_index.ts:874
Index integrity check (IRangedIndex interface function)

Returns boolean

Generated using TypeDoc