Skip to main content

SortedNode

Used by ObservableSortedList to maintain a red-black binary search tree.

Functions​

IterateNodesRange​

</>
SortedNode:IterateNodesRange(
start: number,
finish: number
) → (T) → (
(
T,
nextIndex: any
) → ...any,
T?
)

Inclusive iterator like string.sub. Faster than skipping because we binary search our initial node

ContainsNode​

</>
SortedNode:ContainsNode(node: SortedNode) → boolean

Returns true if the node is contained within the parent node

Show raw api
{
    "functions": [
        {
            "name": "IterateNodesRange",
            "desc": "Inclusive iterator like string.sub. Faster than skipping because we\nbinary search our initial node",
            "params": [
                {
                    "name": "start",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "finish",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "(T) -> ((T, nextIndex: any) -> ...any, T?)"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 99,
                "path": "src/observablecollection/src/Shared/SortedList/SortedNode.lua"
            }
        },
        {
            "name": "ContainsNode",
            "desc": "Returns true if the node is contained within the parent node",
            "params": [
                {
                    "name": "node",
                    "desc": "",
                    "lua_type": "SortedNode"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 266,
                "path": "src/observablecollection/src/Shared/SortedList/SortedNode.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "SortedNode",
    "desc": "Used by [ObservableSortedList] to maintain a red-black binary search tree.",
    "source": {
        "line": 6,
        "path": "src/observablecollection/src/Shared/SortedList/SortedNode.lua"
    }
}