Skip to main content

Set

Utility functions involving sets, which are tables with the key as an index, and the value as a truthy value.

Functions​

union​

</>
Set.union(
set: table,
otherSet: table
) → table

Unions the set with the other set, making a copy.

unionUpdate​

</>
Set.unionUpdate(
set: table,
otherSet: table
) → table

Unions the set with the other set, updating the set

intersection​

</>
Set.intersection(
set: table,
otherSet: table
) → table

Finds the set intersection betwen the two sets

copy​

</>
Set.copy(set: table) → table

Makes a copy of the set, making the values as true.

count​

</>
Set.count(set: Set<T>) → number

Counts the number of entries in the set (linear)

fromKeys​

</>
Set.fromKeys(tab: table) → table

Makes a new set from the given keys of a table

fromTableValue​

</>
Set.fromTableValue(tab: table) → table

Converts a set from table values.

fromList​

</>
Set.fromList(tab: table) → table

Converts a set from a list

toList​

</>
Set.toList(set: table) → table

Converts a set to a list

differenceUpdate​

</>
Set.differenceUpdate(
set: table,
otherSet: table
) → table

Converts a set to a list

difference​

</>
Set.difference(
set: table,
otherSet: table
) → table

Computes the set difference between the two sets

Show raw api
{
    "functions": [
        {
            "name": "union",
            "desc": "Unions the set with the other set, making a copy.",
            "params": [
                {
                    "name": "set",
                    "desc": "",
                    "lua_type": "table"
                },
                {
                    "name": "otherSet",
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 20,
                "path": "src/table/src/Shared/Set.lua"
            }
        },
        {
            "name": "unionUpdate",
            "desc": "Unions the set with the other set, updating the `set`",
            "params": [
                {
                    "name": "set",
                    "desc": "",
                    "lua_type": "table"
                },
                {
                    "name": "otherSet",
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 37,
                "path": "src/table/src/Shared/Set.lua"
            }
        },
        {
            "name": "intersection",
            "desc": "Finds the set intersection betwen the two sets",
            "params": [
                {
                    "name": "set",
                    "desc": "",
                    "lua_type": "table"
                },
                {
                    "name": "otherSet",
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 49,
                "path": "src/table/src/Shared/Set.lua"
            }
        },
        {
            "name": "copy",
            "desc": "Makes a copy of the set, making the values as true.",
            "params": [
                {
                    "name": "set",
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 64,
                "path": "src/table/src/Shared/Set.lua"
            }
        },
        {
            "name": "count",
            "desc": "Counts the number of entries in the set (linear)",
            "params": [
                {
                    "name": "set",
                    "desc": "",
                    "lua_type": "Set<T>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 75,
                "path": "src/table/src/Shared/Set.lua"
            }
        },
        {
            "name": "fromKeys",
            "desc": "Makes a new set from the given keys of a table",
            "params": [
                {
                    "name": "tab",
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 88,
                "path": "src/table/src/Shared/Set.lua"
            }
        },
        {
            "name": "fromTableValue",
            "desc": "Converts a set from table values.",
            "params": [
                {
                    "name": "tab",
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 101,
                "path": "src/table/src/Shared/Set.lua"
            }
        },
        {
            "name": "fromList",
            "desc": "Converts a set from a list",
            "params": [
                {
                    "name": "tab",
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 118,
                "path": "src/table/src/Shared/Set.lua"
            }
        },
        {
            "name": "toList",
            "desc": "Converts a set to a list",
            "params": [
                {
                    "name": "set",
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 125,
                "path": "src/table/src/Shared/Set.lua"
            }
        },
        {
            "name": "differenceUpdate",
            "desc": "Converts a set to a list",
            "params": [
                {
                    "name": "set",
                    "desc": "",
                    "lua_type": "table"
                },
                {
                    "name": "otherSet",
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 141,
                "path": "src/table/src/Shared/Set.lua"
            }
        },
        {
            "name": "difference",
            "desc": "Computes the set difference between the two sets",
            "params": [
                {
                    "name": "set",
                    "desc": "",
                    "lua_type": "table"
                },
                {
                    "name": "otherSet",
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 153,
                "path": "src/table/src/Shared/Set.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "Set",
    "desc": "Utility functions involving sets, which are tables with the key as an index, and the value as a\ntruthy value.",
    "source": {
        "line": 7,
        "path": "src/table/src/Shared/Set.lua"
    }
}