Search
Preparing search index...
The search index is not available
swimOS
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Globals
@swim/collections
STree
Class STree<V, I>
Type parameters
V
I
Hierarchy
STreeContext
<
V
,
I
>
STree
Index
Constructors
constructor
Properties
page
Split
Size
root
Accessors
length
Methods
clear
clone
compare
copy
drop
entries
for
Each
get
get
Entry
identify
insert
is
Empty
keys
lookup
move
page
Should
Merge
page
Should
Split
pop
push
remove
reverse
Entries
reverse
Keys
reverse
Values
set
shift
splice
take
unshift
values
Constructors
constructor
new STree
(
root
?:
STreePage
<
V
,
I
>
)
:
STree
Parameters
Default value
root:
STreePage
<
V
,
I
>
= STree.Page.empty()
Returns
STree
Properties
page
Split
Size
page
Split
Size
:
number
root
root
:
STreePage
<
V
,
I
>
Accessors
length
get
length
(
)
:
number
Returns
number
Methods
clear
clear
(
)
:
void
Returns
void
clone
clone
(
)
:
STree
<
V
,
I
>
Returns
STree
<
V
,
I
>
compare
compare
(
x
:
I
, y
:
I
)
:
number
Parameters
x:
I
y:
I
Returns
number
Protected
copy
copy
(
root
:
STreePage
<
V
,
I
>
)
:
STree
<
V
,
I
>
Parameters
root:
STreePage
<
V
,
I
>
Returns
STree
<
V
,
I
>
drop
drop
(
lower
:
number
)
:
this
Parameters
lower:
number
Returns
this
entries
entries
(
)
:
Cursor
<
[
I
,
V
]
>
Returns
Cursor
<
[
I
,
V
]
>
for
Each
for
Each<T, S>
(
callback
:
function
, thisArg
?:
S
)
:
T
|
undefined
Type parameters
T
S
Parameters
callback:
function
(
this
:
S
, value
:
V
, index
:
number
, tree
:
STree
<
V
,
I
>
, id
:
I
)
:
T
|
void
Parameters
this:
S
value:
V
index:
number
tree:
STree
<
V
,
I
>
id:
I
Returns
T
|
void
Optional
thisArg:
S
Returns
T
|
undefined
get
get
(
index
:
number
, id
?:
I
)
:
V
|
undefined
Parameters
index:
number
Optional
id:
I
Returns
V
|
undefined
get
Entry
get
Entry
(
index
:
number
, id
?:
I
)
:
[
I
,
V
]
|
undefined
Parameters
index:
number
Optional
id:
I
Returns
[
I
,
V
]
|
undefined
identify
identify
(
value
:
V
)
:
I
Parameters
value:
V
Returns
I
insert
insert
(
index
:
number
, newValue
:
V
, id
?:
I
)
:
this
Parameters
index:
number
newValue:
V
Optional
id:
I
Returns
this
is
Empty
is
Empty
(
)
:
boolean
Returns
boolean
keys
keys
(
)
:
Cursor
<
I
>
Returns
Cursor
<
I
>
lookup
lookup
(
id
:
I
, start
?:
number
)
:
number
Parameters
id:
I
Default value
start:
number
= 0
Returns
number
move
move
(
fromIndex
:
number
, toIndex
:
number
, id
?:
I
)
:
this
Parameters
fromIndex:
number
toIndex:
number
Optional
id:
I
Returns
this
page
Should
Merge
page
Should
Merge
(
page
:
STreePage
<
V
,
I
>
)
:
boolean
Parameters
page:
STreePage
<
V
,
I
>
Returns
boolean
page
Should
Split
page
Should
Split
(
page
:
STreePage
<
V
,
I
>
)
:
boolean
Parameters
page:
STreePage
<
V
,
I
>
Returns
boolean
pop
pop
(
)
:
V
|
undefined
Returns
V
|
undefined
push
push
(
...
newValues
:
V
[]
)
:
number
Parameters
Rest
...
newValues:
V
[]
Returns
number
remove
remove
(
index
:
number
, id
?:
I
)
:
this
Parameters
index:
number
Optional
id:
I
Returns
this
reverse
Entries
reverse
Entries
(
)
:
Cursor
<
[
I
,
V
]
>
Returns
Cursor
<
[
I
,
V
]
>
reverse
Keys
reverse
Keys
(
)
:
Cursor
<
I
>
Returns
Cursor
<
I
>
reverse
Values
reverse
Values
(
)
:
Cursor
<
V
>
Returns
Cursor
<
V
>
set
set
(
index
:
number
, newValue
:
V
, id
?:
I
)
:
this
Parameters
index:
number
newValue:
V
Optional
id:
I
Returns
this
shift
shift
(
)
:
V
|
undefined
Returns
V
|
undefined
splice
splice
(
start
:
number
, deleteCount
?:
undefined
|
number
,
...
newValues
:
V
[]
)
:
V
[]
Parameters
start:
number
Optional
deleteCount:
undefined
|
number
Rest
...
newValues:
V
[]
Returns
V
[]
take
take
(
upper
:
number
)
:
this
Parameters
upper:
number
Returns
this
unshift
unshift
(
...
newValues
:
V
[]
)
:
number
Parameters
Rest
...
newValues:
V
[]
Returns
number
values
values
(
)
:
Cursor
<
V
>
Returns
Cursor
<
V
>
Globals
@swim/core
@swim/codec
@swim/collections
@swim/dataflow
@swim/math
@swim/recon
@swim/streamlet
@swim/structure
@swim/time
@swim/uri
@swim/util
@swim/mesh
@swim/ui
@swim/ux
@swim/web
BTree
BTree
Node
Cursor
STree
constructor
page
Split
Size
root
length
clear
clone
compare
copy
drop
entries
for
Each
get
get
Entry
identify
insert
is
Empty
keys
lookup
move
page
Should
Merge
page
Should
Split
pop
push
remove
reverse
Entries
reverse
Keys
reverse
Values
set
shift
splice
take
unshift
values