Module:TableTools - Revision history

Sushoff: Created page with "------------------------------------------------------------------------------------ -- 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 -- -- be called directly from #invoke...."

2025-02-01T13:35:44Z

Created page with "------------------------------------------------------------------------------------ -- 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 -- -- be called directly from #invoke...."

← Older revision	Revision as of 13:35, 1 February 2025
(No difference)

imported>Pppery: Update from sandbox per request

2024-08-18T04:19:07Z

Update from sandbox per request

← Older revision		Revision as of 04:19, 18 August 2024
Line 460:		Line 460:
	-- inArray		-- inArray
	--		--
	-- Returns true if ~~valueToFind~~ is a member of the array, and false otherwise.		-- Returns true if searchElement is a member of the array, and false otherwise.
			-- Equivalent to JavaScript array.includes(searchElement) or
			-- array.includes(searchElement, fromIndex), except fromIndex is 1 indexed
	------------------------------------------------------------------------------------		------------------------------------------------------------------------------------
	function p.inArray(~~arr~~, ~~valueToFind~~)		function p.inArray(array, searchElement, fromIndex)
	checkType("inArray", 1, ~~arr~~, "table")		checkType("inArray", 1, array, "table")
	-- if ~~valueToFind~~ is nil, error?		-- if searchElement is nil, error?

			fromIndex = tonumber(fromIndex)
⚫	for _, v in ~~ipairs~~(~~arr~~) do
	if ~~v == valueToFind~~ then		if fromIndex then
			if (fromIndex < 0) then
⚫	return true
			fromIndex = #array + fromIndex + 1
			end
			if fromIndex < 1 then fromIndex = 1 end
			for _, v in ipairs({unpack(array, fromIndex)}) do
			if v == searchElement then
		⚫	return true
			end
			end
			else
		⚫	for _, v in pairs(array) do
			if v == searchElement then
			return true
			end
	end		end
	end		end

imported>Pppery: Update from sandbox per request

2024-04-27T01:49:03Z

Update from sandbox per request

@@ Line 72: / Line 72: @@
 			-- NaNs can't be table keys, and they are also unique, so we don't need to check existence.
 			ret[#ret + 1] = v
-			if not exists[v] then
+			ret[#ret + 1] = v
-				ret[#ret + 1] = v
+			exists[v] = true
 		end
 	end
@@ Line 380: / Line 378: @@
 ------------------------------------------------------------------------------------
 local function _deepCopy(orig, includeMetatable, already_seen)
 	local copy = already_seen[orig]
 	if copy ~= nil then
 		return copy
 	end
-		for orig_key, orig_value in pairs(orig) do
+	for orig_key, orig_value in pairs(orig) do
-			copy[_deepCopy(orig_key, includeMetatable, already_seen)] = _deepCopy(orig_value, includeMetatable, already_seen)
+		copy[_deepCopy(orig_key, includeMetatable, already_seen)] = _deepCopy(orig_value, includeMetatable, already_seen)
-		if includeMetatable then
+	if includeMetatable then
-			local mt = getmetatable(orig)
+		local mt = getmetatable(orig)
-			if mt ~= nil then
+		if mt ~= nil then
-				local mt_copy = _deepCopy(mt, includeMetatable, already_seen)
+			setmetatable(copy, _deepCopy(mt, true, already_seen))
 		end
 	end
 	return copy
 end
@@ Line 411: / Line 407: @@
 function p.deepCopy(orig, noMetatable, already_seen)
 	checkType("deepCopy", 3, already_seen, "table", true)
-	return _deepCopy(orig, not noMetatable, already_seen)
+	return _deepCopy(orig, not noMetatable, already_seen or {})
 end
@@ Line 476: / Line 472: @@
 	end
 	return false
 end

imported>MSGJ: updates/fixes requested by User:Uzume

2022-01-31T13:08:18Z

updates/fixes requested by User:Uzume

← Older revision		Revision as of 13:08, 31 January 2022
Line 38:		Line 38:
	------------------------------------------------------------------------------------		------------------------------------------------------------------------------------
	function p.isNan(v)		function p.isNan(v)
	return type(v) == 'number' and ~~tostring(~~v) == ~~'-nan'~~		return type(v) == 'number' and v ~= v
	end		end

Line 64:		Line 64:
	-- removed, but otherwise the array order is unchanged.		-- removed, but otherwise the array order is unchanged.
	------------------------------------------------------------------------------------		------------------------------------------------------------------------------------
	function p.removeDuplicates(t)		function p.removeDuplicates(arr)
	checkType('removeDuplicates', 1, t, 'table')		checkType('removeDuplicates', 1, arr, 'table')
	local isNan = p.isNan		local isNan = p.isNan
	local ret, exists = {}, {}		local ret, exists = {}, {}
	for _, v in ipairs(t) do		for _, v in ipairs(arr) do
	if isNan(v) then		if isNan(v) then
	-- NaNs can't be table keys, and they are also unique, so we don't need to check existence.		-- NaNs can't be table keys, and they are also unique, so we don't need to check existence.
Line 337:		Line 337:
	--		--
	-- Transposes the keys and values in an array. For example, {"a", "b", "c"} ->		-- Transposes the keys and values in an array. For example, {"a", "b", "c"} ->
	-- {a = 1, b = 2, c = 3}.		-- {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)		function p.invert(arr)
	checkType("invert", 1, arr, "table")		checkType("invert", 1, arr, "table")
			local isNan = p.isNan

	local map = {}		local map = {}
	for i, v in ipairs(arr) do		for i, v in ipairs(arr) do
			if not isNan(v) then
	map[v] = i		map[v] = i
			end
	end		end

Line 355:		Line 358:
	-- Creates a set from the array part of the table. Indexing the set by any of the		-- Creates a set from the array part of the table. Indexing the set by any of the
	-- values of the array returns true. For example, {"a", "b", "c"} ->		-- values of the array returns true. For example, {"a", "b", "c"} ->
	-- {a = true, b = true, c = true}.		-- {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(t)		function p.listToSet(arr)
	checkType("listToSet", 1, t, "table")		checkType("listToSet", 1, arr, "table")
			local isNan = p.isNan

	local set = {}		local set = {}
	for _, ~~item~~ in ipairs(t) do		for _, v in ipairs(arr) do
			if not isNan(v) then
	set[~~item~~] = true		set[v] = true
			end
	end		end

imported>MSGJ: improved module formatting; improved isArray; added isArrayLike; fixed _deepCopy; and improved defaultKeySort, code by User:Alexiscoutinho

2021-10-04T10:40:18Z

improved module formatting; improved isArray; added isArrayLike; fixed _deepCopy; and improved defaultKeySort, code by User:Alexiscoutinho

Show changes

imported>GorillaWarfare: Changed protection level for "Module:TableTools": High-risk Lua module: bumping protection level due to high usage, plus the stability of the module. See https://en.wikipedia.org/w/index.php?title=Wikipedia:Requests_for_page_protection&oldid=983044034#Module:TableTools ([Edit=Require administrator access] (indefinite) [Move=Require administrator access] (indefinite))

2020-10-11T22:22:43Z

Changed protection level for "Module:TableTools": High-risk Lua module: bumping protection level due to high usage, plus the stability of the module. See https://en.wikipedia.org/w/index.php?title=Wikipedia:Requests_for_page_protection&oldid=983044034#Module:TableTools ([Edit=Require administrator access] (indefinite) [Move=Require administrator access] (indefinite))

← Older revision	Revision as of 22:22, 11 October 2020
(No difference)

imported>Dinoguy1000: from sandbox: another slight code simplification and a couple comment fixes

2020-05-23T15:51:01Z

from sandbox: another slight code simplification and a couple comment fixes

← Older revision		Revision as of 15:51, 23 May 2020
Line 129:		Line 129:
	local function cleanPattern(s)		local function cleanPattern(s)
	-- Cleans a pattern so that the magic characters ()%.[]*+-?^$ are interpreted literally.		-- Cleans a pattern so that the magic characters ()%.[]*+-?^$ are interpreted literally.
	~~s =~~ s:gsub('([%(%)%%%.%[%]%*%+%-%?%^%$])', '%%%1')		return s:gsub('([%(%)%%%.%[%]%*%+%-%?%^%$])', '%%%1')
	return s
	end		end

Line 415:		Line 414:
	--[[		--[[
	-- Finds the length of an array, or of a quasi-array with keys such		-- Finds the length of an array, or of a quasi-array with keys such
	-- as "data1", "data2", etc., using an ~~exponental~~ search algorithm.		-- as "data1", "data2", etc., using an exponential search algorithm.
	-- It is similar to the operator #, but may return		-- It is similar to the operator #, but may return
	-- a different value when there are gaps in the array portion of the table.		-- a different value when there are gaps in the array portion of the table.
Line 425:		Line 424:

	function p.length(t, prefix)		function p.length(t, prefix)
	-- requiring module inline so that [[Module:~~Exponental~~ search]]		-- requiring module inline so that [[Module:Exponential search]]
	-- which is only needed by this one function		-- which is only needed by this one function
	-- doesn't get millions of transclusions		-- doesn't get millions of transclusions

imported>Pppery: Finally getting around to merging in Module:Array length (originally written by Mr. Stradivarius) over six months after writing the merged code, also minor code simplify per Dinoguy1000 on talk page

2019-12-21T03:39:49Z

Finally getting around to merging in Module:Array length (originally written by Mr. Stradivarius) over six months after writing the merged code, also minor code simplify per Dinoguy1000 on talk page

@@ Line 30: / Line 30: @@
 --]]
 function p.isPositiveInteger(v)
-	if type(v) == 'number' and v >= 1 and floor(v) == v and v < infinity then
+	return type(v) == 'number' and v >= 1 and floor(v) == v and v < infinity
 end
@@ Line 48: / Line 44: @@
 --]]
 function p.isNan(v)
-	if type(v) == 'number' and tostring(v) == '-nan' then
+	return type(v) == 'number' and tostring(v) == '-nan'
 end
@@ Line 422: / Line 414: @@
 --[[
--- This returns the length of a table, or the first integer key n counting from
+-- Finds the length of an array, or of a quasi-array with keys such
--- 1 such that t[n + 1] is nil. It is similar to the operator #, but may return
+-- It is similar to the operator #, but may return
 -- a different value when there are gaps in the array portion of the table.
 -- Intended to be used on data loaded with mw.loadData. For other tables, use #.
@@ Line 430: / Line 423: @@
 -- frame.args.
 --]]
 function p.inArray(arr, valueToFind)
 	checkType("inArray", 1, arr, "table")

imported>Alex 21: Implementing talk page edit requested

2019-03-12T13:06:11Z

Implementing talk page edit requested

← Older revision		Revision as of 13:06, 12 March 2019
Line 426:		Line 426:
	-- a different value when there are gaps in the array portion of the table.		-- a different value when there are gaps in the array portion of the table.
	-- Intended to be used on data loaded with mw.loadData. For other tables, use #.		-- Intended to be used on data loaded with mw.loadData. For other tables, use #.
			-- Note: #frame.args in frame object always be set to 0, regardless of
			-- the number of unnamed template parameters, so use this function for
			-- frame.args.
	--]]		--]]
	function p.length(t)		function p.length(t)
	local i = 0		local i = 1
		⚫	while t[i] ~= nil do
	repeat
	i = i + 1		i = i + 1
			end
⚫	~~until~~ t[i] == nil
	return i - 1		return i - 1
	end		end

imported>Pppery at 21:35, 19 February 2019

2019-02-19T21:35:25Z

← Older revision		Revision as of 21:35, 19 February 2019
Line 304:		Line 304:
	]]		]]
	function p.sortedPairs(t, keySort)		function p.sortedPairs(t, keySort)
	local check = _check('keysToList')
	checkType('sortedPairs', 1, t, 'table')		checkType('sortedPairs', 1, t, 'table')
	checkType('sortedPairs', 2, keySort, 'function', true)		checkType('sortedPairs', 2, keySort, 'function', true)