sonic-radiance/sonic-radiance.love/birb/utils/table.lua
2021-05-15 15:50:15 +02:00

103 lines
3.2 KiB
Lua

-- loveutils.table : simple functions for table manipulation and computation.
--[[
Copyright © 2021 Kazhnuz
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
]]
local Table = {}
function Table.contain(table, content)
for k, v in ipairs(table) do
if (v == content) then
return true
end
end
return false
end
function Table.toString(table)
local string = "{"
for key, value in pairs(table) do
string = string .. key .. ":"
if (type(value) == "table") then
string = string .. Table.toString(value)
elseif type(value) == "boolean" then
if (value) then
string = string .. "true"
else
string = string .. "false"
end
else
string = string .. value
end
string = string .. ","
end
return string .. "}"
end
function Table.reduce(list, fn)
local acc
for k, v in ipairs(list) do
if 1 == k then
acc = v
else
acc = fn(acc, v)
end
end
return acc
end
function Table.sum(table)
local sum = 0
for _, v in pairs(table) do
sum = sum + v
end
return sum
end
function Table.average(table)
return Table.sum(table) / #table
end
--Parse a basic list into a structured table. Return an error if the number of arguments is not the same
---@param table table the list to parse into a table
---@param structure table the structure to create the table : each name correspond to an attribute of the parsed table
---@param nullableNbr integer the number of nullable argument (at the end of the functions) (can be null)
---@return table parsedTable the parsed table
function Table.parse(table, structure, nullableNbr)
local parsedTable = {}
assert(table ~= nil, "The table to parse can't be null")
assert(structure ~= nil, "The table structure can't be null")
nullableNbr = nullableNbr or 0
if ((#table) > (#structure)) or ((#table) < (#structure - nullableNbr)) then
error("The table to parse doesn't have the right number of arguments: " .. #table .. " instead of " .. #structure .. " and " .. nullableNbr .. " nullables")
else
for i, key in ipairs(structure) do
--print(i, key, table[i])
parsedTable[key] = table[i]
end
end
return parsedTable
end
return Table