Features
There are certain convinient features beyond the API, which are in the root type of List and is also inherited downwards. These are primarily built on the metamethods available in Luau, so more may be added if possible!
Negative Indexing
Negative indicies allow you to reference from the end-to-start direction, where -1 denotes the very last element, -2 second to last, etc.
local MyNumList = NumList.new({90, 92, 94, 96, 98, 100})
print(MyNumList[-1]) --100
Slicing
Using calls, just like with functions, you are able to pass the parameters to slice (or get a certain part of) the List or NumList. It takes in up to three parameters:
* int lower -- lower bound
* int upper = List.Length -- upper bound; default is the end of the list
* int step = 1 -- incremend the indexing; default is 1 (consecutive elements)
Additionally, you are able to input negative numbers!
local MyNumList = NumList.fromRange(1, 25)
print(MyNumList(-15, -1, 2)) --NumList({11, 13, 15, 17, 19, 21, 23, 25})
--or reverse the list using negative step!
print(MyNumList(-15, -1, -2)) --NumList({25, 23, 21, 19, 17, 15, 13, 11})
Concatenation
Merge two Lists or NumLists together on the stop using the concatenation operator.
local MyList1 = List.new({1, "two", 3})
local MyList2 = List.new({"four", 5, 6})
print(MyList1 .. MyList2) --NumList({1, "two", 3, "four", 5, 6})
MyList2 ..= MyList1
print(MyList2) --NumList({"four", 5, 6, 1, "two", 3})
Comparisons
With Lists and NumLists, you can check the equality of any two of them:
local MyList1 = List.new({"one", "two", 3})
local MyList2 = List.new({4, 5, "six"})
print(MyList1 == MyList2) --false
MyList1 = MyList2:Clone()
print(MyList1 == MyList2) --true
With NumLists specifically, the sums of the two will be calculated and compared:
local MyNumList1 = NumList.new({58, 10, 9})
local MyNumList2 = NumList.new({10, 9, 2})
print(MyNumList1 > MyNumList2) --true
print(MyNumList1 >= MyNumList2) --true
print(MyNumList1 < MyNumList2) --false
print(MyNumList1 <= MyNumList2) --false
In the future, there may be an option to choose your "compairson metric" between sum, average, min, max, etc.!
Operations
With NumLists, you are able to add, subtract, multiply, divide, mod, and exponentiate them with a number or another table/NumList of an equal length.
local MyNumList = NumList.fromRange(1, 5)
print(MyNumList + 2) --NumList({3, 4, 5, 6, 7})
print(MyNumList * {2, 3, 4, 5, 6}) --NumList({2, 6, 12, 20, 30})
print(MyNumList / {1, 2}) --error (not equal length)
Raising Errors
ListLib tries its best to catch errors with parameters and arguments, so you are able to fix the issue without having to sort through the internal code. Usually it's in the format of:
[action]: [reason]
NumList, if you input non-intengers as the input, you may see:
slicing: inputs must be integers