Class STree<V, I>

Type Parameters

V = unknown
I = unknown

Hierarchy

STreeContext<V, I>
- STree

Index

Constructors

Properties

Accessors

Constructors

constructor

new STree<V, I>(): STree<V, I>
Type Parameters
- V = unknown
- I = unknown
Returns STree<V, I>
Overrides STreeContext.constructor
- Defined in swim-collections/lib/main/STree.d.ts:8

Properties

pageSplitSize

pageSplitSize: number

Accessors

length

get length(): number
Returns number
- Defined in swim-collections/lib/main/STree.d.ts:11

Methods

[iterator]

[iterator](): Cursor<V>
Returns Cursor<V>
- Defined in swim-collections/lib/main/STree.d.ts:29

clear

clear(): void
Returns void
- Defined in swim-collections/lib/main/STree.d.ts:26

clone

clone(): STree<V, I>
Returns STree<V, I>
- Defined in swim-collections/lib/main/STree.d.ts:36

compare

compare(x, y): number
Parameters
- x: I
- y: I
Returns number
Inherited from STreeContext.compare
- Defined in swim-collections/lib/main/STreeContext.d.ts:6

drop

drop(lower): STree<V, I>
Parameters
- lower: number
Returns STree<V, I>
- Defined in swim-collections/lib/main/STree.d.ts:24

entries

entries(): Cursor<[I, V]>
Returns Cursor<[I, V]>
- Defined in swim-collections/lib/main/STree.d.ts:32

forEach

forEach<T>(callback): T
Type Parameters
- T
Parameters
- callback: ((value, index, id, tree) => void | T)
  - - (value, index, id, tree): void | T
    - Parameters
      
      value: V
      
      index: number
      
      id: I
      
      tree: STree<V, I>
      
      Returns void | T
Returns T
- Defined in swim-collections/lib/main/STree.d.ts:27
forEach<T, S>(callback, thisArg): T
Type Parameters
- T
- S
Parameters
- callback: ((this, value, index, id, tree) => void | T)
  - - (this, value, index, id, tree): void | T
    - Parameters
      
      this: S
      
      value: V
      
      index: number
      
      id: I
      
      tree: STree<V, I>
      
      Returns void | T
- thisArg: S
Returns T
- Defined in swim-collections/lib/main/STree.d.ts:28

get

get(index, id?): V
Parameters
- index: number
- Optional id: I
Returns V
- Defined in swim-collections/lib/main/STree.d.ts:13

getEntry

getEntry(index, id?): [I, V]
Parameters
- index: number
- Optional id: I
Returns [I, V]
- Defined in swim-collections/lib/main/STree.d.ts:14

identify

identify(value): I
Parameters
- value: V
Returns I
Inherited from STreeContext.identify
- Defined in swim-collections/lib/main/STreeContext.d.ts:5

insert

insert(index, newValue, id?): STree<V, I>
Parameters
- index: number
- newValue: V
- Optional id: I
Returns STree<V, I>
- Defined in swim-collections/lib/main/STree.d.ts:16

isEmpty

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

keys

keys(): Cursor<I>
Returns Cursor<I>
- Defined in swim-collections/lib/main/STree.d.ts:30

lookup

lookup(id, start?): number
Parameters
- id: I
- Optional start: number
Returns number
- Defined in swim-collections/lib/main/STree.d.ts:39

move

move(fromIndex, toIndex, id?): STree<V, I>
Parameters
- fromIndex: number
- toIndex: number
- Optional id: I
Returns STree<V, I>
- Defined in swim-collections/lib/main/STree.d.ts:22

pop

pop(): V
Returns V
- Defined in swim-collections/lib/main/STree.d.ts:19

push

push(...newValues): number
Parameters
- Rest ...newValues: V[]
Returns number
- Defined in swim-collections/lib/main/STree.d.ts:18

remove

remove(index, id?): STree<V, I>
Parameters
- index: number
- Optional id: I
Returns STree<V, I>
- Defined in swim-collections/lib/main/STree.d.ts:17

reverseEntries

reverseEntries(): Cursor<[I, V]>
Returns Cursor<[I, V]>
- Defined in swim-collections/lib/main/STree.d.ts:35

reverseKeys

reverseKeys(): Cursor<I>
Returns Cursor<I>
- Defined in swim-collections/lib/main/STree.d.ts:33

reverseValues

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

set

set(index, newValue, id?): STree<V, I>
Parameters
- index: number
- newValue: V
- Optional id: I
Returns STree<V, I>
- Defined in swim-collections/lib/main/STree.d.ts:15

shift

shift(): V
Returns V
- Defined in swim-collections/lib/main/STree.d.ts:21

splice

splice(start, deleteCount?, ...newValues): V[]
Parameters
- start: number
- Optional deleteCount: number
- Rest ...newValues: V[]
Returns V[]
- Defined in swim-collections/lib/main/STree.d.ts:23

take

take(upper): STree<V, I>
Parameters
- upper: number
Returns STree<V, I>
- Defined in swim-collections/lib/main/STree.d.ts:25

unshift

unshift(...newValues): number
Parameters
- Rest ...newValues: V[]
Returns number
- Defined in swim-collections/lib/main/STree.d.ts:20

values

values(): Cursor<V>
Returns Cursor<V>
- Defined in swim-collections/lib/main/STree.d.ts:31

Generated using TypeDoc