Class BTree<K, V, U>

Type Parameters

K = unknown
V = unknown
U = never

Hierarchy

BTreeContext<K, V>
- BTree

Implements

ReducedMap<K, V, U>

Index

Constructors

Properties

Accessors

[toStringTag] size

Constructors

constructor

new BTree<K, V, U>(): BTree<K, V, U>
Type Parameters
- K = unknown
- V = unknown
- U = never
Returns BTree<K, V, U>
Overrides BTreeContext.constructor
- Defined in swim-collections/lib/main/BTree.d.ts:9

Properties

pageSplitSize

pageSplitSize: number

Accessors

[toStringTag]

get [toStringTag](): string
Returns string
Implementation of ReducedMap.[toStringTag]
- Defined in swim-collections/lib/main/BTree.d.ts:54

size

get size(): number
Returns number
Implementation of ReducedMap.size
- Defined in swim-collections/lib/main/BTree.d.ts:12

Methods

[iterator]

[iterator](): Cursor<[K, V]>
Returns Cursor<[K, V]>
Implementation of ReducedMap.[iterator]
- Defined in swim-collections/lib/main/BTree.d.ts:44

clear

clear(): void
Returns void
Implementation of ReducedMap.clear
- Defined in swim-collections/lib/main/BTree.d.ts:33

cleared

cleared(): BTree<K, V, U>
Returns BTree<K, V, U>
- Defined in swim-collections/lib/main/BTree.d.ts:36

clone

clone(): BTree<K, V, U>
Returns BTree<K, V, U>
- Defined in swim-collections/lib/main/BTree.d.ts:51

compare

compare(x, y): number
Parameters
- x: K
- y: K
Returns number
Inherited from BTreeContext.compare
- Defined in swim-collections/lib/main/BTreeContext.d.ts:5

delete

delete(key): boolean
Parameters
- key: K
Returns boolean
Implementation of ReducedMap.delete
- Defined in swim-collections/lib/main/BTree.d.ts:30

drop

drop(lower): BTree<K, V, U>
Parameters
- lower: number
Returns BTree<K, V, U>
- Defined in swim-collections/lib/main/BTree.d.ts:31

entries

entries(): Cursor<[K, V]>
Returns Cursor<[K, V]>
Implementation of ReducedMap.entries
- Defined in swim-collections/lib/main/BTree.d.ts:47

firstEntry

firstEntry(): [K, V]
Returns [K, V]
Implementation of ReducedMap.firstEntry
- Defined in swim-collections/lib/main/BTree.d.ts:19

firstKey

firstKey(): K
Returns K
Implementation of ReducedMap.firstKey
- Defined in swim-collections/lib/main/BTree.d.ts:17

firstValue

firstValue(): V
Returns V
Implementation of ReducedMap.firstValue
- Defined in swim-collections/lib/main/BTree.d.ts:18

forEach

forEach<T>(callback): T
Type Parameters
- T
Parameters
- callback: ((value, key, tree) => void | T)
  - - (value, key, tree): void | T
    - Parameters
      
      value: V
      
      key: K
      
      tree: BTree<K, V, U>
      
      Returns void | T
Returns T
Implementation of ReducedMap.forEach
- Defined in swim-collections/lib/main/BTree.d.ts:38
forEach<T, S>(callback, thisArg?): T
Type Parameters
- T
- S
Parameters
- callback: ((this, value, key, tree) => void | T)
  - - (this, value, key, tree): void | T
    - Parameters
      
      this: S
      
      value: V
      
      key: K
      
      tree: BTree<K, V, U>
      
      Returns void | T
- Optional thisArg: S
Returns T
Implementation of ReducedMap.forEach
- Defined in swim-collections/lib/main/BTree.d.ts:39

forEachKey

forEachKey<T>(callback): T
Type Parameters
- T
Parameters
- callback: ((key, tree) => void | T)
  - - (key, tree): void | T
    - Parameters
      
      key: K
      
      tree: BTree<K, V, U>
      
      Returns void | T
Returns T
- Defined in swim-collections/lib/main/BTree.d.ts:40
forEachKey<T, S>(callback, thisArg): T
Type Parameters
- T
- S
Parameters
- callback: ((this, key, tree) => void | T)
  - - (this, key, tree): void | T
    - Parameters
      
      this: S
      
      key: K
      
      tree: BTree<K, V, U>
      
      Returns void | T
- thisArg: S
Returns T
- Defined in swim-collections/lib/main/BTree.d.ts:41

forEachValue

forEachValue<T>(callback): T
Type Parameters
- T
Parameters
- callback: ((value, tree) => void | T)
  - - (value, tree): void | T
    - Parameters
      
      value: V
      
      tree: BTree<K, V, U>
      
      Returns void | T
Returns T
- Defined in swim-collections/lib/main/BTree.d.ts:42
forEachValue<T, S>(callback, thisArg): T
Type Parameters
- T
- S
Parameters
- callback: ((this, value, tree) => void | T)
  - - (this, value, tree): void | T
    - Parameters
      
      this: S
      
      value: V
      
      tree: BTree<K, V, U>
      
      Returns void | T
- thisArg: S
Returns T
- Defined in swim-collections/lib/main/BTree.d.ts:43

get

get(key): V
Parameters
- key: K
Returns V
Implementation of ReducedMap.get
- Defined in swim-collections/lib/main/BTree.d.ts:15

getEntry

getEntry(index): [K, V]
Parameters
- index: number
Returns [K, V]
Implementation of ReducedMap.getEntry
- Defined in swim-collections/lib/main/BTree.d.ts:16

has

has(key): boolean
Parameters
- key: K
Returns boolean
Implementation of ReducedMap.has
- Defined in swim-collections/lib/main/BTree.d.ts:14

isEmpty

isEmpty(): boolean
Returns boolean
- Defined in swim-collections/lib/main/BTree.d.ts:13

keys

keys(): Cursor<K>
Returns Cursor<K>
Implementation of ReducedMap.keys
- Defined in swim-collections/lib/main/BTree.d.ts:45

lastEntry

lastEntry(): [K, V]
Returns [K, V]
Implementation of ReducedMap.lastEntry
- Defined in swim-collections/lib/main/BTree.d.ts:22

lastKey

lastKey(): K
Returns K
Implementation of ReducedMap.lastKey
- Defined in swim-collections/lib/main/BTree.d.ts:20

lastValue

lastValue(): V
Returns V
Implementation of ReducedMap.lastValue
- Defined in swim-collections/lib/main/BTree.d.ts:21

nextEntry

nextEntry(key): [K, V]
Parameters
- key: K
Returns [K, V]
Implementation of ReducedMap.nextEntry
- Defined in swim-collections/lib/main/BTree.d.ts:25

nextKey

nextKey(key): K
Parameters
- key: K
Returns K
Implementation of ReducedMap.nextKey
- Defined in swim-collections/lib/main/BTree.d.ts:23

nextValue

nextValue(key): V
Parameters
- key: K
Returns V
Implementation of ReducedMap.nextValue
- Defined in swim-collections/lib/main/BTree.d.ts:24

previousEntry

previousEntry(key): [K, V]
Parameters
- key: K
Returns [K, V]
Implementation of ReducedMap.previousEntry
- Defined in swim-collections/lib/main/BTree.d.ts:28

previousKey

previousKey(key): K
Parameters
- key: K
Returns K
Implementation of ReducedMap.previousKey
- Defined in swim-collections/lib/main/BTree.d.ts:26

previousValue

previousValue(key): V
Parameters
- key: K
Returns V
Implementation of ReducedMap.previousValue
- Defined in swim-collections/lib/main/BTree.d.ts:27

reduced

reduced(identity, accumulator, combiner): U
Parameters
- identity: U
- accumulator: ((result, element) => U)
  - - (result, element): U
    - Parameters
      
      result: U
      
      element: V
      
      Returns U
- combiner: ((result, result2) => U)
  - - (result, result2): U
    - Parameters
      
      result: U
      
      result2: U
      
      Returns U
Returns U
Implementation of ReducedMap.reduced
- Defined in swim-collections/lib/main/BTree.d.ts:37

removed

removed(key): BTree<K, V, U>
Parameters
- key: K
Returns BTree<K, V, U>
- Defined in swim-collections/lib/main/BTree.d.ts:35

reverseEntries

reverseEntries(): Cursor<[K, V]>
Returns Cursor<[K, V]>
- Defined in swim-collections/lib/main/BTree.d.ts:50

reverseKeys

reverseKeys(): Cursor<K>
Returns Cursor<K>
- Defined in swim-collections/lib/main/BTree.d.ts:48

reverseValues

reverseValues(): Cursor<V>
Returns Cursor<V>
- Defined in swim-collections/lib/main/BTree.d.ts:49

set

set(key, newValue): BTree<K, V, U>
Parameters
- key: K
- newValue: V
Returns BTree<K, V, U>
Implementation of ReducedMap.set
- Defined in swim-collections/lib/main/BTree.d.ts:29

take

take(upper): BTree<K, V, U>
Parameters
- upper: number
Returns BTree<K, V, U>
- Defined in swim-collections/lib/main/BTree.d.ts:32

updated

updated(key, newValue): BTree<K, V, U>
Parameters
- key: K
- newValue: V
Returns BTree<K, V, U>
- Defined in swim-collections/lib/main/BTree.d.ts:34

values

values(): Cursor<V>
Returns Cursor<V>
Implementation of ReducedMap.values
- Defined in swim-collections/lib/main/BTree.d.ts:46

Generated using TypeDoc