Class BTree<K, V, U>

Type parameters

K
V
U

Hierarchy

BTreeContext<K, V>
- BTree

Implements

ReducedMap<K, V, U>

Index

Constructors

constructor

Properties

Accessors

size

Methods

Constructors

constructor

new BTree(root?: BTreePage<K, V, U>): BTree

- Defined in swim-core-js/@swim/collections/main/BTree.ts:23
Parameters
- Default value root: BTreePage<K, V, U> = BTree.Page.empty()
Returns BTree

Properties

pageSplitSize

pageSplitSize: number

root

root: BTreePage<K, V, U>

Accessors

size

get size(): number

- Defined in swim-core-js/@swim/collections/main/BTree.ts:30
Returns number

Methods

clear

clear(): void

Implementation of ReducedMap.clear
- Defined in swim-core-js/@swim/collections/main/BTree.ts:183
Returns void

cleared

cleared(): BTree<K, V>

- Defined in swim-core-js/@swim/collections/main/BTree.ts:210
Returns BTree<K, V>

clone

clone(): BTree<K, V>

- Defined in swim-core-js/@swim/collections/main/BTree.ts:259
Returns BTree<K, V>

compare

compare(x: K, y: K): number

Inherited from BTreeContext.compare
- Defined in swim-core-js/@swim/collections/main/BTreeContext.ts:22
Parameters
- x: K
- y: K
Returns number

Protected copy

copy(root: BTreePage<K, V, U>): BTree<K, V, U>

- Defined in swim-core-js/@swim/collections/main/BTree.ts:263
Parameters
- root: BTreePage<K, V, U>
Returns BTree<K, V, U>

delete

delete(key: K): boolean

Implementation of ReducedMap.delete
- Defined in swim-core-js/@swim/collections/main/BTree.ts:150
Parameters
- key: K
Returns boolean

drop

drop(lower: number): this

- Defined in swim-core-js/@swim/collections/main/BTree.ts:161
Parameters
- lower: number
Returns this

entries

entries(): Cursor<[K, V]>

Implementation of ReducedMap.entries
- Defined in swim-core-js/@swim/collections/main/BTree.ts:243
Returns Cursor<[K, V]>

firstEntry

firstEntry(): [K, V] | undefined

Implementation of ReducedMap.firstEntry
- Defined in swim-core-js/@swim/collections/main/BTree.ts:68
Returns [K, V] | undefined

firstKey

firstKey(): K | undefined

Implementation of ReducedMap.firstKey
- Defined in swim-core-js/@swim/collections/main/BTree.ts:50
Returns K | undefined

firstValue

firstValue(): V | undefined

Implementation of ReducedMap.firstValue
- Defined in swim-core-js/@swim/collections/main/BTree.ts:59
Returns V | undefined

forEach

forEach<T, S>(callback: function, thisArg?: S): T | undefined

- Defined in swim-core-js/@swim/collections/main/BTree.ts:227
Type parameters
- T
- S
Parameters
- callback: function
  - - (this: S, key: K, value: V, tree: BTree<K, V>): T | void
    - Parameters
      - this: S
      - key: K
      - value: V
      - tree: BTree<K, V>
      Returns T | void
- Optional thisArg: S
Returns T | undefined

get

get(key: K): V | undefined

Implementation of ReducedMap.get
- Defined in swim-core-js/@swim/collections/main/BTree.ts:42
Parameters
- key: K
Returns V | undefined

getEntry

getEntry(index: number): [K, V] | undefined

Implementation of ReducedMap.getEntry
- Defined in swim-core-js/@swim/collections/main/BTree.ts:46
Parameters
- index: number
Returns [K, V] | undefined

has

has(key: K): boolean

Implementation of ReducedMap.has
- Defined in swim-core-js/@swim/collections/main/BTree.ts:38
Parameters
- key: K
Returns boolean

isEmpty

isEmpty(): boolean

Implementation of ReducedMap.isEmpty
- Defined in swim-core-js/@swim/collections/main/BTree.ts:34
Returns boolean

keys

keys(): Cursor<K>

Implementation of ReducedMap.keys
- Defined in swim-core-js/@swim/collections/main/BTree.ts:235
Returns Cursor<K>

lastEntry

lastEntry(): [K, V] | undefined

Implementation of ReducedMap.lastEntry
- Defined in swim-core-js/@swim/collections/main/BTree.ts:90
Returns [K, V] | undefined

lastKey

lastKey(): K | undefined

Implementation of ReducedMap.lastKey
- Defined in swim-core-js/@swim/collections/main/BTree.ts:72
Returns K | undefined

lastValue

lastValue(): V | undefined

Implementation of ReducedMap.lastValue
- Defined in swim-core-js/@swim/collections/main/BTree.ts:81
Returns V | undefined

nextEntry

nextEntry(key: K): [K, V] | undefined

Implementation of ReducedMap.nextEntry
- Defined in swim-core-js/@swim/collections/main/BTree.ts:112
Parameters
- key: K
Returns [K, V] | undefined

nextKey

nextKey(key: K): K | undefined

Implementation of ReducedMap.nextKey
- Defined in swim-core-js/@swim/collections/main/BTree.ts:94
Parameters
- key: K
Returns K | undefined

nextValue

nextValue(key: K): V | undefined

Implementation of ReducedMap.nextValue
- Defined in swim-core-js/@swim/collections/main/BTree.ts:103
Parameters
- key: K
Returns V | undefined

pageShouldMerge

pageShouldMerge(page: BTreePage<K, V, unknown>): boolean

Inherited from BTreeContext.pageShouldMerge
- Defined in swim-core-js/@swim/collections/main/BTreeContext.ts:30
Parameters
- page: BTreePage<K, V, unknown>
Returns boolean

pageShouldSplit

pageShouldSplit(page: BTreePage<K, V, unknown>): boolean

Inherited from BTreeContext.pageShouldSplit
- Defined in swim-core-js/@swim/collections/main/BTreeContext.ts:26
Parameters
- page: BTreePage<K, V, unknown>
Returns boolean

previousEntry

previousEntry(key: K): [K, V] | undefined

Implementation of ReducedMap.previousEntry
- Defined in swim-core-js/@swim/collections/main/BTree.ts:134
Parameters
- key: K
Returns [K, V] | undefined

previousKey

previousKey(key: K): K | undefined

Implementation of ReducedMap.previousKey
- Defined in swim-core-js/@swim/collections/main/BTree.ts:116
Parameters
- key: K
Returns K | undefined

previousValue

previousValue(key: K): V | undefined

Implementation of ReducedMap.previousValue
- Defined in swim-core-js/@swim/collections/main/BTree.ts:125
Parameters
- key: K
Returns V | undefined

reduced

reduced(identity: U, accumulator: function, combiner: function): U

- Defined in swim-core-js/@swim/collections/main/BTree.ts:218
Parameters
- identity: U
- accumulator: function
  - - (result: U, element: V): U
    - Parameters
      - result: U
      - element: V
      Returns U
- combiner: function
  - - (result: U, result2: U): U
    - Parameters
      - result: U
      - result2: U
      Returns U
Returns U

removed

removed(key: K): BTree<K, V>

- Defined in swim-core-js/@swim/collections/main/BTree.ts:200
Parameters
- key: K
Returns BTree<K, V>

reverseEntries

reverseEntries(): Cursor<[K, V]>

- Defined in swim-core-js/@swim/collections/main/BTree.ts:255
Returns Cursor<[K, V]>

reverseKeys

reverseKeys(): Cursor<K>

- Defined in swim-core-js/@swim/collections/main/BTree.ts:247
Returns Cursor<K>

reverseValues

reverseValues(): Cursor<V>

- Defined in swim-core-js/@swim/collections/main/BTree.ts:251
Returns Cursor<V>

set

set(key: K, newValue: V): this

Implementation of ReducedMap.set
- Defined in swim-core-js/@swim/collections/main/BTree.ts:138
Parameters
- key: K
- newValue: V
Returns this

take

take(upper: number): this

- Defined in swim-core-js/@swim/collections/main/BTree.ts:172
Parameters
- upper: number
Returns this

updated

updated(key: K, newValue: V): BTree<K, V>

- Defined in swim-core-js/@swim/collections/main/BTree.ts:187
Parameters
- key: K
- newValue: V
Returns BTree<K, V>

values

values(): Cursor<V>

Implementation of ReducedMap.values
- Defined in swim-core-js/@swim/collections/main/BTree.ts:239
Returns Cursor<V>