Skip to main content

PriorityQueue

Implementation of a PriorityQueue

Functions​

new​

</>
PriorityQueue.new() → PriorityQueue<T>

Constructs a new priority queue

Enqueue​

</>
PriorityQueue:Enqueue(
item: T,
priority: number
) → ()

Enqueues a new item into the queue

Dequeue​

</>
PriorityQueue:Dequeue() → T

Dequeues the first item in the PriorityQueue

IsEmpty​

</>
PriorityQueue:IsEmpty() → boolean

Returns true if the PriorityQueue is empty. False otherwise

Size​

</>
PriorityQueue:Size() → number

Returns the current size of the PriorityQueue

_peek​

</>
PriorityQueue:_peek() → number

Returns earliest element with the highest priority

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new priority queue",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "PriorityQueue <T>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 21,
                "path": "src/priorityqueue/src/Shared/PriorityQueue.lua"
            }
        },
        {
            "name": "Enqueue",
            "desc": "Enqueues a new item into the queue",
            "params": [
                {
                    "name": "item",
                    "desc": "",
                    "lua_type": "T"
                },
                {
                    "name": "priority",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 36,
                "path": "src/priorityqueue/src/Shared/PriorityQueue.lua"
            }
        },
        {
            "name": "Dequeue",
            "desc": "Dequeues the first item in the PriorityQueue",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "T"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 60,
                "path": "src/priorityqueue/src/Shared/PriorityQueue.lua"
            }
        },
        {
            "name": "IsEmpty",
            "desc": "Returns true if the PriorityQueue is empty. False otherwise",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 81,
                "path": "src/priorityqueue/src/Shared/PriorityQueue.lua"
            }
        },
        {
            "name": "Size",
            "desc": "Returns the current size of the PriorityQueue",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 90,
                "path": "src/priorityqueue/src/Shared/PriorityQueue.lua"
            }
        },
        {
            "name": "_peek",
            "desc": "Returns earliest element with the highest priority",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 97,
                "path": "src/priorityqueue/src/Shared/PriorityQueue.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "PriorityQueue",
    "desc": "Implementation of a PriorityQueue",
    "source": {
        "line": 6,
        "path": "src/priorityqueue/src/Shared/PriorityQueue.lua"
    }
}