Search
Preparing search index...
The search index is not available
Swim Toolkit
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Swim Toolkit
@swim/collections
BTree
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
constructor
Properties
root
Accessors
page
Split
Size
size
Methods
clear
cleared
clone
compare
copy
delete
drop
entries
first
Entry
first
Key
first
Value
for
Each
for
Each
Key
for
Each
Value
get
get
Entry
has
is
Empty
keys
last
Entry
last
Key
last
Value
next
Entry
next
Key
next
Value
page
Should
Merge
page
Should
Split
previous
Entry
previous
Key
previous
Value
reduced
removed
reverse
Entries
reverse
Keys
reverse
Values
set
take
updated
values
Constructors
constructor
new BTree<K, V, U>
(
root
?:
BTreePage
<
K
,
V
,
U
>
)
:
BTree
<
K
,
V
,
U
>
Type parameters
K =
unknown
V =
unknown
U =
never
Parameters
Optional
root:
BTreePage
<
K
,
V
,
U
>
Returns
BTree
<
K
,
V
,
U
>
Properties
root
root
:
BTreePage
<
K
,
V
,
U
>
Accessors
page
Split
Size
get
pageSplitSize
(
)
:
number
set
pageSplitSize
(
pageSplitSize
:
number
)
:
any
Returns
number
Parameters
pageSplitSize:
number
Returns
any
size
get
size
(
)
:
number
Returns
number
Methods
clear
clear
(
)
:
void
Returns
void
cleared
cleared
(
)
:
BTree
<
K
,
V
,
U
>
Returns
BTree
<
K
,
V
,
U
>
clone
clone
(
)
:
BTree
<
K
,
V
,
U
>
Returns
BTree
<
K
,
V
,
U
>
compare
compare
(
x
:
K
, y
:
K
)
:
number
Parameters
x:
K
y:
K
Returns
number
Protected
copy
copy
(
root
:
BTreePage
<
K
,
V
,
U
>
)
:
BTree
<
K
,
V
,
U
>
Parameters
root:
BTreePage
<
K
,
V
,
U
>
Returns
BTree
<
K
,
V
,
U
>
delete
delete
(
key
:
K
)
:
boolean
Parameters
key:
K
Returns
boolean
drop
drop
(
lower
:
number
)
:
BTree
<
K
,
V
,
U
>
Parameters
lower:
number
Returns
BTree
<
K
,
V
,
U
>
entries
entries
(
)
:
Cursor
<
[
K
,
V
]
>
Returns
Cursor
<
[
K
,
V
]
>
first
Entry
first
Entry
(
)
:
undefined
|
[
K
,
V
]
Returns
undefined
|
[
K
,
V
]
first
Key
first
Key
(
)
:
undefined
|
K
Returns
undefined
|
K
first
Value
first
Value
(
)
:
undefined
|
V
Returns
undefined
|
V
for
Each
for
Each<T>
(
callback
:
(
key
:
K
, value
:
V
)
=>
void
|
T
)
:
undefined
|
T
for
Each<T, S>
(
callback
:
(
key
:
K
, value
:
V
)
=>
void
|
T
, thisArg
:
S
)
:
undefined
|
T
Type parameters
T
Parameters
callback:
(
key
:
K
, value
:
V
)
=>
void
|
T
(
key
:
K
, value
:
V
)
:
void
|
T
Parameters
key:
K
value:
V
Returns
void
|
T
Returns
undefined
|
T
Type parameters
T
S
Parameters
callback:
(
key
:
K
, value
:
V
)
=>
void
|
T
(
key
:
K
, value
:
V
)
:
void
|
T
Parameters
key:
K
value:
V
Returns
void
|
T
thisArg:
S
Returns
undefined
|
T
for
Each
Key
for
Each
Key<T>
(
callback
:
(
key
:
K
)
=>
void
|
T
)
:
undefined
|
T
for
Each
Key<T, S>
(
callback
:
(
key
:
K
)
=>
void
|
T
, thisArg
:
S
)
:
undefined
|
T
Type parameters
T
Parameters
callback:
(
key
:
K
)
=>
void
|
T
(
key
:
K
)
:
void
|
T
Parameters
key:
K
Returns
void
|
T
Returns
undefined
|
T
Type parameters
T
S
Parameters
callback:
(
key
:
K
)
=>
void
|
T
(
key
:
K
)
:
void
|
T
Parameters
key:
K
Returns
void
|
T
thisArg:
S
Returns
undefined
|
T
for
Each
Value
for
Each
Value<T>
(
callback
:
(
value
:
V
)
=>
void
|
T
)
:
undefined
|
T
for
Each
Value<T, S>
(
callback
:
(
value
:
V
)
=>
void
|
T
, thisArg
:
S
)
:
undefined
|
T
Type parameters
T
Parameters
callback:
(
value
:
V
)
=>
void
|
T
(
value
:
V
)
:
void
|
T
Parameters
value:
V
Returns
void
|
T
Returns
undefined
|
T
Type parameters
T
S
Parameters
callback:
(
value
:
V
)
=>
void
|
T
(
value
:
V
)
:
void
|
T
Parameters
value:
V
Returns
void
|
T
thisArg:
S
Returns
undefined
|
T
get
get
(
key
:
K
)
:
undefined
|
V
Parameters
key:
K
Returns
undefined
|
V
get
Entry
get
Entry
(
index
:
number
)
:
undefined
|
[
K
,
V
]
Parameters
index:
number
Returns
undefined
|
[
K
,
V
]
has
has
(
key
:
K
)
:
boolean
Parameters
key:
K
Returns
boolean
is
Empty
is
Empty
(
)
:
boolean
Returns
boolean
keys
keys
(
)
:
Cursor
<
K
>
Returns
Cursor
<
K
>
last
Entry
last
Entry
(
)
:
undefined
|
[
K
,
V
]
Returns
undefined
|
[
K
,
V
]
last
Key
last
Key
(
)
:
undefined
|
K
Returns
undefined
|
K
last
Value
last
Value
(
)
:
undefined
|
V
Returns
undefined
|
V
next
Entry
next
Entry
(
key
:
K
)
:
undefined
|
[
K
,
V
]
Parameters
key:
K
Returns
undefined
|
[
K
,
V
]
next
Key
next
Key
(
key
:
K
)
:
undefined
|
K
Parameters
key:
K
Returns
undefined
|
K
next
Value
next
Value
(
key
:
K
)
:
undefined
|
V
Parameters
key:
K
Returns
undefined
|
V
page
Should
Merge
page
Should
Merge
(
page
:
BTreePage
<
K
,
V
,
unknown
>
)
:
boolean
Parameters
page:
BTreePage
<
K
,
V
,
unknown
>
Returns
boolean
page
Should
Split
page
Should
Split
(
page
:
BTreePage
<
K
,
V
,
unknown
>
)
:
boolean
Parameters
page:
BTreePage
<
K
,
V
,
unknown
>
Returns
boolean
previous
Entry
previous
Entry
(
key
:
K
)
:
undefined
|
[
K
,
V
]
Parameters
key:
K
Returns
undefined
|
[
K
,
V
]
previous
Key
previous
Key
(
key
:
K
)
:
undefined
|
K
Parameters
key:
K
Returns
undefined
|
K
previous
Value
previous
Value
(
key
:
K
)
:
undefined
|
V
Parameters
key:
K
Returns
undefined
|
V
reduced
reduced
(
identity
:
U
, accumulator
:
(
result
:
U
, element
:
V
)
=>
U
, combiner
:
(
result
:
U
, result2
:
U
)
=>
U
)
:
U
Parameters
identity:
U
accumulator:
(
result
:
U
, element
:
V
)
=>
U
(
result
:
U
, element
:
V
)
:
U
Parameters
result:
U
element:
V
Returns
U
combiner:
(
result
:
U
, result2
:
U
)
=>
U
(
result
:
U
, result2
:
U
)
:
U
Parameters
result:
U
result2:
U
Returns
U
Returns
U
removed
removed
(
key
:
K
)
:
BTree
<
K
,
V
,
U
>
Parameters
key:
K
Returns
BTree
<
K
,
V
,
U
>
reverse
Entries
reverse
Entries
(
)
:
Cursor
<
[
K
,
V
]
>
Returns
Cursor
<
[
K
,
V
]
>
reverse
Keys
reverse
Keys
(
)
:
Cursor
<
K
>
Returns
Cursor
<
K
>
reverse
Values
reverse
Values
(
)
:
Cursor
<
V
>
Returns
Cursor
<
V
>
set
set
(
key
:
K
, newValue
:
V
)
:
BTree
<
K
,
V
,
U
>
Parameters
key:
K
newValue:
V
Returns
BTree
<
K
,
V
,
U
>
take
take
(
upper
:
number
)
:
BTree
<
K
,
V
,
U
>
Parameters
upper:
number
Returns
BTree
<
K
,
V
,
U
>
updated
updated
(
key
:
K
, newValue
:
V
)
:
BTree
<
K
,
V
,
U
>
Parameters
key:
K
newValue:
V
Returns
BTree
<
K
,
V
,
U
>
values
values
(
)
:
Cursor
<
V
>
Returns
Cursor
<
V
>
Modules
@swim/system
@swim/core
@swim/util
@swim/codec
@swim/mapping
@swim/collections
@swim/constraint
@swim/structure
@swim/streamlet
@swim/dataflow
@swim/recon
@swim/uri
@swim/math
@swim/geo
@swim/time
@swim/mesh
@swim/toolkit
BTree
constructor
root
page
Split
Size
size
clear
cleared
clone
compare
copy
delete
drop
entries
first
Entry
first
Key
first
Value
for
Each
for
Each
Key
for
Each
Value
get
get
Entry
has
is
Empty
keys
last
Entry
last
Key
last
Value
next
Entry
next
Key
next
Value
page
Should
Merge
page
Should
Split
previous
Entry
previous
Key
previous
Value
reduced
removed
reverse
Entries
reverse
Keys
reverse
Values
set
take
updated
values
BTree
Context
BTree
Leaf
BTree
Node
BTree
Node
Cursor
BTree
Page
Keys
Cursor
Node
Cursor
STree
STree
Context
STree
Leaf
STree
Node
STree
Node
Cursor
STree
Page
Values
Cursor
Generated using
TypeDoc