Module:TableTools/doc - Revision history

Grufo: +internal links

2025-04-19T18:25:44Z

+internal links

← Previous revision		Revision as of 18:25, 19 April 2025
Line 60:		Line 60:

	Takes a table <code>''t''</code> and returns an array containing the numbers of keys with the optional prefix <code>''prefix''</code> and the optional suffix <code>''suffix''</code>. For example, for the table {{code\|code={a1 = 'foo', a3 = 'bar', a6 = 'baz'}\|lang=lua}} and the prefix <code>'a'</code>, <code>affixNums</code> will return {{code\|code={1, 3, 6}\|lang=lua}}. All characters in <code>''prefix''</code> and <code>''suffix''</code> are interpreted literally.		Takes a table <code>''t''</code> and returns an array containing the numbers of keys with the optional prefix <code>''prefix''</code> and the optional suffix <code>''suffix''</code>. For example, for the table {{code\|code={a1 = 'foo', a3 = 'bar', a6 = 'baz'}\|lang=lua}} and the prefix <code>'a'</code>, <code>affixNums</code> will return {{code\|code={1, 3, 6}\|lang=lua}}. All characters in <code>''prefix''</code> and <code>''suffix''</code> are interpreted literally.

			See {{mfl\|params\|call_for_each_group}} and {{mfl\|params\|grouping_by_calling}} for doing something similar from a wiki template.

	== numData ==		== numData ==
Line 76:		Line 78:

	Takes an array <code>''t''</code> with one or more nil values, and removes the nil values while preserving the order, so that the array can be safely traversed with <code>ipairs</code>. Any keys that are not positive integers are removed. For example, for the table {{code\|code={1, nil, foo = 'bar', 3, 2}\|lang=lua}}, <code>compressSparseArray</code> will return {{code\|code={1, 3, 2}\|lang=lua}}.		Takes an array <code>''t''</code> with one or more nil values, and removes the nil values while preserving the order, so that the array can be safely traversed with <code>ipairs</code>. Any keys that are not positive integers are removed. For example, for the table {{code\|code={1, nil, foo = 'bar', 3, 2}\|lang=lua}}, <code>compressSparseArray</code> will return {{code\|code={1, 3, 2}\|lang=lua}}.

			See {{mfl\|params\|squeezing}} for doing something similar from a wiki template.

	== sparseIpairs ==		== sparseIpairs ==

64.114 etc at 03:14, 19 October 2024

2024-10-19T03:14:29Z

← Previous revision		Revision as of 03:14, 19 October 2024
Line 1:		Line 1:
	{{used in system}}		{{used in system}}
	{{module rating\|~~protected~~}}		{{module rating\|p}}
			{{cascade-protected template\|page=module}}
	{{lua\|Module:Exponential search\|noprotcat=yes}}		{{lua\|Module:Exponential search\|noprotcat=yes}}
	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.		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.

Ahecht: Update inArray

2024-08-19T02:01:06Z

Update inArray

← Previous revision		Revision as of 02:01, 19 August 2024
Line 180:		Line 180:
	== inArray ==		== inArray ==

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">TableTools.inArray(array, searchElement)
	TableTools.inArray(~~arr~~, ~~valueToFind~~)		TableTools.inArray(array, searchElement, fromIndex)</syntaxhighlight>
	</syntaxhighlight>

	Returns <code>true</code> if <code>''~~valueToFind~~''</code> is a member of the array <code>''~~arr~~''</code>, and <code>false</code> otherwise.		Returns <code>true</code> if <code>''searchElement''</code> is a member of the array <code>''array''</code>, and <code>false</code> otherwise. Equivalent to the javascript [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/includes Array.prototype.includes()] function, except fromIndex is 1-indexed instead of zero-indexed.

			=== fromIndex ===
			<code>fromIndex</code> is the optional 1-based index at which to start searching. If <code>fromIndex</code> is not present, all values in the array will be searched and the array will be treated as a table/[[associative array]] (it will be iterated over using <syntaxhighlight lang="lua" inline>pairs()</syntaxhighlight>).

			If <code>fromIndex</code> is present and an integer, the array is assumed to be a conventional array/sequence/list (indexed with consecutive integer keys starting at <code>1</code>, and interated over using <syntaxhighlight lang="lua" inline>ipairs()</syntaxhighlight>). Only the values whose index is <code>fromIndex</code> or higher will be searched.

			In the following examples, <code>#array</code> represents the length of the integer-keyed portion of the array.

			* If <code>fromIndex < 0</code> it will count back from the end of the array, e.g. a value of <code>-1</code> will only search the last integer-keyed element in the array. If <code>fromIndex <= (-1 * #array)</code>, the entire integer-keyed portion of the array will be searched.
			* If <code>fromIndex = 0</code> it will be treated as a <code>1</code> and the entire integer-keyed portion of the array will be searched.
			* If <code>fromIndex > #array</code>, the array is not searched and <code>false</code> is returned.

	== merge ==		== merge ==

Ahecht: c/e "size"

2024-08-14T20:17:33Z

c/e "size"

← Previous revision		Revision as of 20:17, 14 August 2024
Line 100:		Line 100:
	</syntaxhighlight>		</syntaxhighlight>

	Finds the size of a key/value pair table. For example, for ~~the table~~ {{code\|code={foo = 'foo', bar = 'bar'}\|lang=lua}}, <code>size</code> will return <code>2</code>. The function will also work on arrays, but for arrays it is more efficient to use the <code>#</code> operator. Note that to find the ~~table~~ size, this function uses the <code>[[mw:Extension:Scribunto/Lua reference manual#pairs\|pairs]]</code> function to iterate through all of the ~~table~~ keys.		Finds the size of a key/value pair table ([[associative array]]). For example, for {{code\|code={foo = 'foo', bar = 'bar'}\|lang=lua}}, <code>size</code> will return <code>2</code>. The function will also work on arrays, but for arrays it is more efficient to use the <code>#</code> operator. Note that to find the size, this function uses the <code>[[mw:Extension:Scribunto/Lua reference manual#pairs\|pairs]]</code> function to iterate through all of the keys.

	== keysToList ==		== keysToList ==

Annh07: Reverted edit by 223.123.6.236 (talk) to last version by Grufo

2024-06-16T16:26:41Z

Reverted edit by 223.123.6.236 (talk) to last version by Grufo

← Previous revision		Revision as of 16:26, 16 June 2024
Line 7:		Line 7:

	To use any of the functions, first you must load the module.		To use any of the functions, first you must load the module.
	https://shopapk.com/

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 34:		Line 33:
	TableTools.shallowClone(t)		TableTools.shallowClone(t)
	</syntaxhighlight>		</syntaxhighlight>
	https://shopapk.com/

	Returns a clone of a table. The value returned is a new table, but all subtables and functions are shared. Metamethods are respected, but the returned table will have no metatable of its own. If you want to make a new table with no shared subtables and with metatables transferred, you can use <code>[[mw:Extension:Scribunto/Lua reference manual#mw.clone\|mw.clone]]</code> instead. If you want to make a new table with no shared subtables and without metatables transferred, use <code>[[#deepCopy\|deepCopy]]</code> with the <code>noMetatable</code> option.		Returns a clone of a table. The value returned is a new table, but all subtables and functions are shared. Metamethods are respected, but the returned table will have no metatable of its own. If you want to make a new table with no shared subtables and with metatables transferred, you can use <code>[[mw:Extension:Scribunto/Lua reference manual#mw.clone\|mw.clone]]</code> instead. If you want to make a new table with no shared subtables and without metatables transferred, use <code>[[#deepCopy\|deepCopy]]</code> with the <code>noMetatable</code> option.

223.123.6.236 at 16:24, 16 June 2024

2024-06-16T16:24:32Z

← Previous revision		Revision as of 16:24, 16 June 2024
Line 7:		Line 7:

	To use any of the functions, first you must load the module.		To use any of the functions, first you must load the module.
			https://shopapk.com/

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 33:		Line 34:
	TableTools.shallowClone(t)		TableTools.shallowClone(t)
	</syntaxhighlight>		</syntaxhighlight>
			https://shopapk.com/

	Returns a clone of a table. The value returned is a new table, but all subtables and functions are shared. Metamethods are respected, but the returned table will have no metatable of its own. If you want to make a new table with no shared subtables and with metatables transferred, you can use <code>[[mw:Extension:Scribunto/Lua reference manual#mw.clone\|mw.clone]]</code> instead. If you want to make a new table with no shared subtables and without metatables transferred, use <code>[[#deepCopy\|deepCopy]]</code> with the <code>noMetatable</code> option.		Returns a clone of a table. The value returned is a new table, but all subtables and functions are shared. Metamethods are respected, but the returned table will have no metatable of its own. If you want to make a new table with no shared subtables and with metatables transferred, you can use <code>[[mw:Extension:Scribunto/Lua reference manual#mw.clone\|mw.clone]]</code> instead. If you want to make a new table with no shared subtables and without metatables transferred, use <code>[[#deepCopy\|deepCopy]]</code> with the <code>noMetatable</code> option.

Grufo: /* See also */ +{{#invoke:params}}

2024-05-20T07:11:45Z

Alexiscoutinho: Updated documentation with the two new functions

2024-04-27T21:10:25Z

Updated documentation with the two new functions

← Previous revision		Revision as of 21:10, 27 April 2024
Line 185:		Line 185:

	Returns <code>true</code> if <code>''valueToFind''</code> is a member of the array <code>''arr''</code>, and <code>false</code> otherwise.		Returns <code>true</code> if <code>''valueToFind''</code> is a member of the array <code>''arr''</code>, and <code>false</code> otherwise.

			== merge ==

			<syntaxhighlight lang="lua">
			TableTools.merge(...)
			</syntaxhighlight>

			Given the arrays, returns an array containing the elements of each input array in sequence.

			== extend ==

			<syntaxhighlight lang="lua">
			TableTools.extend(arr1, arr2)
			</syntaxhighlight>

			Extends the first array in place by appending all elements from the second array.

	<includeonly>{{Sandbox other\|\|		<includeonly>{{Sandbox other\|\|

Plastikspork: /* listToSet */ Now in sandbox

2024-03-28T13:43:56Z

listToSet: Now in sandbox

← Previous revision		Revision as of 13:43, 28 March 2024
Line 148:		Line 148:
	</syntaxhighlight>		</syntaxhighlight>

	Creates a set from the array part of the table <code>''arr''</code>. Indexing the set by any of the values of the array returns <code>true</code>. For example, {{code\|listToSet{ "a", "b", "c" }\|lua}} yields {{code\|code={ a=true, b=true, c=true }\|lang=lua}}~~. See also [[Module:Lua set]] for more advanced ways to create a set~~.		Creates a set from the array part of the table <code>''arr''</code>. Indexing the set by any of the values of the array returns <code>true</code>. For example, {{code\|listToSet{ "a", "b", "c" }\|lua}} yields {{code\|code={ a=true, b=true, c=true }\|lang=lua}}.

	== deepCopy ==		== deepCopy ==

Pppery: Rv

2023-03-19T23:48:13Z

← Previous revision		Revision as of 23:48, 19 March 2023
Line 1:		Line 1:
	~~Include docs and deeply rooted~~{{used in system}}		{{used in system}}
	{{module rating\|protected}}		{{module rating\|protected}}
	{{lua\|Module:Exponential search\|noprotcat=yes}}		{{lua\|Module:Exponential search\|noprotcat=yes}}

← Previous revision		Revision as of 07:11, 20 May 2024
Line 201:		Line 201:

	Extends the first array in place by appending all elements from the second array.		Extends the first array in place by appending all elements from the second array.

			== See also ==
			* {{ml\|params\|}}

	<includeonly>{{Sandbox other\|\|		<includeonly>{{Sandbox other\|\|