pool

Module:TableTools: Difference between revisions

Browse history interactively
← Older edit
Content deleted Content added
updates/fixes requested by User:Uzume
No edit summary
 
(One intermediate revision by the same user not shown)
Line 1:
--[[
------------------------------------------------------------------------------------
-- TableTools TableTools --
-- --
-- This module includes a number of functions for dealing with Lua tables. --
-- It is a meta-module, meant to be called from other Lua modules, and should not --
-- not be called directly from #invoke. --
------------------------------------------------------------------------------------
--]]
 
local libraryUtil = require('libraryUtil')
Line 17 ⟶ 19:
local checkTypeMulti = libraryUtil.checkTypeMulti
 
--[[
------------------------------------------------------------------------------------
-- isPositiveInteger
Line 25 ⟶ 28:
-- hash part of a table.
------------------------------------------------------------------------------------
--]]
function p.isPositiveInteger(v)
returnif type(v) == 'number' and v >= 1 and floor(v) == v and v < infinity then
return true
else
return false
end
end
 
--[[
------------------------------------------------------------------------------------
-- isNan
--
-- This function returns true if the given number is a NaN value, and false if
-- if not. Although it doesn't operate on tables, it is included here as it is useful
-- useful for determining whether a value can be a valid table key. Lua will generate an
-- generate an error if a NaN is used as a table key.
------------------------------------------------------------------------------------
--]]
function p.isNan(v)
returnif type(v) == 'number' and tostring(v) ~== v'-nan' then
return true
else
return false
end
end
 
--[[
------------------------------------------------------------------------------------
-- shallowClone
Line 48 ⟶ 63:
-- table will have no metatable of its own.
------------------------------------------------------------------------------------
--]]
function p.shallowClone(t)
checkType('shallowClone', 1, t, 'table')
local ret = {}
for k, v in pairs(t) do
Line 57 ⟶ 72:
end
 
--[[
------------------------------------------------------------------------------------
-- removeDuplicates
Line 64 ⟶ 80:
-- removed, but otherwise the array order is unchanged.
------------------------------------------------------------------------------------
--]]
function p.removeDuplicates(arr)
function p.removeDuplicates(t)
checkType('removeDuplicates', 1, arr, 'table')
checkType('removeDuplicates', 1, t, 'table')
local isNan = p.isNan
local ret, exists = {}, {}
for _i, v in ipairs(arrt) do
if isNan(v) then
-- NaNs can't be table keys, and they are also unique, so we don't need to check existence.
Line 77 ⟶ 94:
exists[v] = true
end
end
end
return ret
end
 
--[[
------------------------------------------------------------------------------------
-- numKeys
Line 88 ⟶ 106:
-- keys that have non-nil values, sorted in numerical order.
------------------------------------------------------------------------------------
--]]
function p.numKeys(t)
checkType('numKeys', 1, t, 'table')
local isPositiveInteger = p.isPositiveInteger
local nums = {}
for k, v in pairs(t) do
if isPositiveInteger(k) then
nums[#nums + 1] = k
Line 101 ⟶ 120:
end
 
--[[
------------------------------------------------------------------------------------
-- affixNums
Line 106 ⟶ 126:
-- This takes a table and returns an array containing the numbers of keys with the
-- specified prefix and suffix. For example, for the table
-- {a1 = 'foo', a3 = 'bar', a6 = 'baz'} and the prefix "a", affixNums will return
-- return {1, 3, 6}.
------------------------------------------------------------------------------------
--]]
function p.affixNums(t, prefix, suffix)
checkType('affixNums', 1, t, 'table')
Line 116 ⟶ 137:
local function cleanPattern(s)
-- Cleans a pattern so that the magic characters ()%.[]*+-?^$ are interpreted literally.
returns = s:gsub('([%(%)%%%.%[%]%*%+%-%?%^%$])', '%%%1')
return s
end
 
Line 126 ⟶ 148:
 
local nums = {}
for k, v in pairs(t) do
if type(k) == 'string' then
local num = mw.ustring.match(k, pattern)
if num then
Line 138 ⟶ 160:
end
 
--[[
------------------------------------------------------------------------------------
-- numData
--
-- Given a table with keys like {("foo1", "bar1", "foo2", "baz2"}), returns a table
-- of subtables in the format
-- { [1] = {foo = 'text', bar = 'text'}, [2] = {foo = 'text', baz = 'text'} }.
-- Keys that don't end with an integer are stored in a subtable named "other". The
-- The compress option compresses the table so that it can be iterated over with
-- ipairs.
------------------------------------------------------------------------------------
--]]
function p.numData(t, compress)
checkType('numData', 1, t, 'table')
Line 177 ⟶ 201:
end
 
--[[
------------------------------------------------------------------------------------
-- compressSparseArray
Line 184 ⟶ 209:
-- ipairs.
------------------------------------------------------------------------------------
--]]
function p.compressSparseArray(t)
checkType('compressSparseArray', 1, t, 'table')
Line 194 ⟶ 220:
end
 
--[[
------------------------------------------------------------------------------------
-- sparseIpairs
Line 200 ⟶ 227:
-- handle nil values.
------------------------------------------------------------------------------------
--]]
function p.sparseIpairs(t)
checkType('sparseIpairs', 1, t, 'table')
Line 216 ⟶ 244:
end
 
--[[
------------------------------------------------------------------------------------
-- size
Line 222 ⟶ 251:
-- but for arrays it is more efficient to use the # operator.
------------------------------------------------------------------------------------
--]]
 
function p.size(t)
checkType('size', 1, t, 'table')
local i = 0
for _k in pairs(t) do
i = i + 1
end
return i
end
 
 
local function defaultKeySort(item1, item2)
Line 236 ⟶ 268:
if type1 ~= type2 then
return type1 < type2
elseifelse type1-- ==This 'table'will orfail type1with ==table, 'boolean', or type1 == 'function' then.
return tostring(item1) < tostring(item2)
else
return item1 < item2
end
end
 
------------------------------------------------------------------------------------
--[[
-- keysToList
Returns a list of the keys in a table, sorted using either a default
--
comparison function or a custom keySort function.
-- Returns an array of the keys in a table, sorted using either a default
]]
-- comparison function or a custom keySort function.
------------------------------------------------------------------------------------
function p.keysToList(t, keySort, checked)
if not checked then
checkType('keysToList', 1, t, 'table')
checkTypeMulti('keysToList', 2, keySort, { 'function', 'boolean', 'nil' })
end
 
local arrlist = {}
local index = 1
for kkey, value in pairs(t) do
arrlist[index] = kkey
index = index + 1
end
 
if keySort ~= false then
keySort = type(keySort) == 'function' and keySort or defaultKeySort
table.sort(arr, keySort)
table.sort(list, keySort)
end
 
return arrlist
end
 
--[[
------------------------------------------------------------------------------------
Iterates through a table, with the keys sorted using the keysToList function.
-- sortedPairs
If there are only numerical keys, sparseIpairs is probably more efficient.
--
]]
-- Iterates through a table, with the keys sorted using the keysToList function.
-- If there are only numerical keys, sparseIpairs is probably more efficient.
------------------------------------------------------------------------------------
function p.sortedPairs(t, keySort)
checkType('sortedPairs', 1, t, 'table')
checkType('sortedPairs', 2, keySort, 'function', true)
 
local arrlist = p.keysToList(t, keySort, true)
 
local i = 0
return function ()
i = i + 1
local key = arrlist[i]
if key ~= nil then
return key, t[key]
Line 293 ⟶ 321:
end
 
--[[
------------------------------------------------------------------------------------
Returns true if all keys in the table are consecutive integers starting at 1.
-- isArray
--]]
function p.isArray(t)
-- Returns true if the given value is a table and all keys are consecutive
checkType("isArray", 1, t, "table")
-- integers starting at 1.
------------------------------------------------------------------------------------
function p.isArray(v)
if type(v) ~= 'table' then
return false
end
local i = 0
for _k, v in pairs(vt) do
i = i + 1
if vt[i] == nil then
return false
end
Line 313 ⟶ 337:
end
 
-- { "a", "b", "c" } -> { a = 1, b = 2, c = 3 }
------------------------------------------------------------------------------------
function p.invert(array)
-- isArrayLike
checkType("invert", 1, array, "table")
--
-- Returns true if the given value is iterable and all keys are consecutive
-- integers starting at 1.
------------------------------------------------------------------------------------
function p.isArrayLike(v)
if not pcall(pairs, v) then
return false
end
local i = 0
for _ in pairs(v) do
i = i + 1
if v[i] == nil then
return false
end
end
return true
end
 
------------------------------------------------------------------------------------
-- invert
--
-- Transposes the keys and values in an array. For example, {"a", "b", "c"} ->
-- {a = 1, b = 2, c = 3}. Duplicates are not supported (result values refer to
-- the index of the last duplicate) and NaN values are ignored.
------------------------------------------------------------------------------------
function p.invert(arr)
checkType("invert", 1, arr, "table")
local isNan = p.isNan
local map = {}
for i, v in ipairs(arrarray) do
map[v] = i
if not isNan(v) then
map[v] = i
end
end
 
return map
end
 
--[[
------------------------------------------------------------------------------------
{ "a", "b", "c" } -> { ["a"] = true, ["b"] = true, ["c"] = true }
-- listToSet
--]]
function p.listToSet(t)
-- Creates a set from the array part of the table. Indexing the set by any of the
checkType("listToSet", 1, t, "table")
-- values of the array returns true. For example, {"a", "b", "c"} ->
-- {a = true, b = true, c = true}. NaN values are ignored as Lua considers them
-- never equal to any value (including other NaNs or even themselves).
------------------------------------------------------------------------------------
function p.listToSet(arr)
checkType("listToSet", 1, arr, "table")
local isNan = p.isNan
local set = {}
for _, vitem in ipairs(arrt) do
set[item] = true
if not isNan(v) then
set[v] = true
end
end
 
return set
end
 
--[[
------------------------------------------------------------------------------------
Recursive deep copy function.
-- deepCopy
Preserves identities of subtables.
--
-- Recursive deep copy function. Preserves identities of subtables.
]]
------------------------------------------------------------------------------------
local function _deepCopy(orig, includeMetatable, already_seen)
-- Stores copies of tables indexed by the original table.
already_seen = already_seen or {}
 
local copy = already_seen[orig]
if copy ~= nil then
return copy
end
 
if type(orig) == 'table' then
copy = {}
for orig_key, orig_value in pairs(orig) do
copy[_deepCopydeepcopy(orig_key, includeMetatable, already_seen)] = _deepCopydeepcopy(orig_value, includeMetatable, already_seen)
end
already_seen[orig] = copy
 
if includeMetatable then
local mt = getmetatable(orig)
if mt ~= nil then
local mt_copy = _deepCopydeepcopy(mt, includeMetatable, already_seen)
setmetatable(copy, mt_copy)
already_seen[mt] = mt_copy
Line 411 ⟶ 400:
function p.deepCopy(orig, noMetatable, already_seen)
checkType("deepCopy", 3, already_seen, "table", true)
return _deepCopy(orig, not noMetatable, already_seen)
end
 
--[[
------------------------------------------------------------------------------------
Concatenates all values in the table that are indexed by a number, in order.
-- sparseConcat
sparseConcat{ a, nil, c, d } => "acd"
--
sparseConcat{ nil, b, c, d } => "bcd"
-- Concatenates all values in the table that are indexed by a number, in order.
]]
-- sparseConcat{a, nil, c, d} => "acd"
-- sparseConcat{nil, b, c, d} => "bcd"
------------------------------------------------------------------------------------
function p.sparseConcat(t, sep, i, j)
local arrlist = {}
 
local arr_ilist_i = 0
for _, v in p.sparseIpairs(t) do
arr_ilist_i = arr_ilist_i + 1
arrlist[arr_ilist_i] = v
end
 
return table.concat(arrlist, sep, i, j)
end
 
--[[
------------------------------------------------------------------------------------
-- This returns the length of a table, or the first integer key n counting from
-- length
-- 1 such that t[n + 1] is nil. It is similar to the operator #, but may return
--
-- Findsa thedifferent lengthvalue ofwhen anthere array,are orgaps ofin athe quasi-array withportion keysof such asthe "data1",table.
-- Intended to be used on data loaded with mw.loadData. For other tables, use #.
-- "data2", etc., using an exponential search algorithm. It is similar to the
-- Note: #frame.args in frame object always be set to 0, regardless of
-- operator #, but may return a different value when there are gaps in the array
-- the number of unnamed template parameters, so use this function for
-- portion of the table. Intended to be used on data loaded with mw.loadData. For
-- frame.args.
-- other tables, use #.
--]]
-- Note: #frame.args in frame object always be set to 0, regardless of the number
function p.length(t)
-- of unnamed template parameters, so use this function for frame.args.
local i = 1
------------------------------------------------------------------------------------
while t[i] ~= nil do
function p.length(t, prefix)
i = i + 1
-- requiring module inline so that [[Module:Exponential search]] which is
end
-- only needed by this one function doesn't get millions of transclusions
return i - 1
local expSearch = require("Module:Exponential search")
checkType('length', 1, t, 'table')
checkType('length', 2, prefix, 'string', true)
return expSearch(function (i)
local key
if prefix then
key = prefix .. tostring(i)
else
key = i
end
return t[key] ~= nil
end) or 0
end
 
------------------------------------------------------------------------------------
-- inArray
--
-- Returns true if valueToFind is a member of the array, and false otherwise.
------------------------------------------------------------------------------------
function p.inArray(arr, valueToFind)
checkType("inArray", 1, arr, "table")
-- if valueToFind is nil, error?
 
for _, v in ipairs(arr) do
if v == valueToFind then
Line 475 ⟶ 448:
end
end
return false
end
Retrieved from "https://pool.calebcooper.ie/Module:TableTools"