Module:TableTools/doc - Revision history

Casiope: /* Loading the module */

2020-07-18T09:42:31Z

Loading the module

← Older revision		Revision as of 09:42, 18 July 2020
Line 5:		Line 5:
	To use any of the functions, first you must load the module.		To use any of the functions, first you must load the module.

	~~<source~~ lang="~~lua~~">		: {{code\|lang="Lua"\|code=local TableTools = require('Module:TableTools')}}
	local TableTools = require('Module:TableTools')
	~~</source>~~

	== isPositiveInteger ==		== isPositiveInteger ==

2020-07-14T00:04:07Z

keysToList

← Older revision		Revision as of 00:04, 14 July 2020
Line 83:		Line 83:
	: <code>TableTools.keysToList({{var\|t}}, {{var\|keySort}})</code>		: <code>TableTools.keysToList({{var\|t}}, {{var\|keySort}})</code>

	Returns a list of the keys in a table, sorted using either a default comparison function or a custom {{~~code~~\|keySort}} function, which follows the same rules as the {{code\|comp}} function supplied to <code>[[mw:Extension:Scribunto/Lua reference manual#table.sort\|table.sort]]</code>.		Returns a list of the keys in a table, sorted using either a default comparison function or a custom {{var\|keySort}} function, which follows the same rules as the {{code\|comp}} function supplied to <code>[[mw:Extension:Scribunto/Lua reference manual#table.sort\|table.sort]]</code>.

	== sortedPairs ==		== sortedPairs ==

2020-07-14T00:03:21Z

numData

← Older revision		Revision as of 00:03, 14 July 2020
Line 49:		Line 49:
	: <code>TableTools.numData({{var\|t}}, {{var\|compress}})</code>		: <code>TableTools.numData({{var\|t}}, {{var\|compress}})</code>

	Given a table with keys like {{code\|"foo1"}}, {{code\|"bar1"}}, {{code\|"foo2"}}, and {{code\|"baz2"}}, returns a table of subtables in the format {{code\|code={ [1] = {foo = 'text', bar = 'text'}, [2] = {foo = 'text', baz = 'text'} }\|lang=lua}}. Keys that don’t end with an integer are stored in a subtable named {{code\|"other"}}. The compress option compresses the table so that it can be iterated over with {{code\|ipairs}}.		Given a table with keys like {{code\|"foo1"}}, {{code\|"bar1"}}, {{code\|"foo2"}}, and {{code\|"baz2"}}, returns a table of subtables in the format {{code\|code={ [1] = {foo = 'text', bar = 'text'}, [2] = {foo = 'text', baz = 'text'} }\|lang=lua}}. Keys that don’t end with an integer are stored in a subtable named {{code\|other}}. The compress option compresses the table so that it can be iterated over with {{code\|ipairs}}.

	== compressSparseArray ==		== compressSparseArray ==

2020-07-14T00:02:36Z

2020-07-13T23:43:38Z

deepCopy

← Older revision		Revision as of 23:43, 13 July 2020
Line 150:		Line 150:
	</source>		</source>

	Creates a copy of the table {{~~code~~\|orig}}. As with <code>mw.clone</code>, all values that are not functions are duplicated and the identity of tables is preserved. If {{~~code~~\|noMetatable}} is {{code\|true}}, then the metatable (if any) is not copied. Can copy tables loaded with <code>mw.loadData</code>.		Creates a copy of the table {{var\|orig}}. As with <code>mw.clone</code>, all values that are not functions are duplicated and the identity of tables is preserved. If {{var\|noMetatable}} is {{code\|true}}, then the metatable (if any) is not copied. Can copy tables loaded with <code>mw.loadData</code>.

	Similar to {{code\|mw.clone}}, but {{code\|mw.clone}} cannot copy tables loaded with {{code\|mw.loadData}} and does not allow metatables {{em\|not}} to be copied.		Similar to {{code\|mw.clone}}, but {{code\|mw.clone}} cannot copy tables loaded with {{code\|mw.loadData}} and does not allow metatables {{em\|not}} to be copied.

2020-07-13T23:40:43Z

inArray

← Older revision		Revision as of 23:40, 13 July 2020
Line 176:		Line 176:
	</source>		</source>

	Returns <syntaxhighlight lang="lua" inline>true</syntaxhighlight> if {{~~code~~\|valueToFind}} is a member of the array {{~~code~~\|arr}}, and <syntaxhighlight lang="lua" inline>false</syntaxhighlight> otherwise.		Returns <syntaxhighlight lang="lua" inline>true</syntaxhighlight> if {{var\|valueToFind}} is a member of the array {{var\|arr}}, and <syntaxhighlight lang="lua" inline>false</syntaxhighlight> otherwise.

	[[Category:Modules]][[Category:Modules documentation]]		[[Category:Modules]][[Category:Modules documentation]]

2020-07-13T23:39:37Z

isArray

← Older revision		Revision as of 23:39, 13 July 2020
Line 121:		Line 121:
	</source>		</source>

	Returns true if all keys in the table are consecutive integers starting at {{code\|1}}.		Returns {{code\|true}} if all keys in the table are consecutive integers starting at {{code\|1}}.

	== listToSet ==		== listToSet ==

2020-07-13T23:38:55Z

compressSparseArray

← Older revision		Revision as of 23:38, 13 July 2020
Line 71:		Line 71:
	</source>		</source>

	Takes an array {{~~code~~\|''t''}} 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}}. 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}} will return {{code\|code={1, 3, 2}\|lang=lua}}.		Takes an array {{var\|t}} 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}}. 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}} will return {{code\|code={1, 3, 2}\|lang=lua}}.

	== sparseIpairs ==		== sparseIpairs ==

2020-07-13T23:38:27Z

affixNums

← Older revision		Revision as of 23:38, 13 July 2020
Line 55:		Line 55:
	</source>		</source>

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

	== numData ==		== numData ==

2020-07-13T23:35:08Z

numKeys

← Older revision		Revision as of 23:35, 13 July 2020
Line 47:		Line 47:
	</source>		</source>

	Takes a table {{~~code~~\|''t''}} and returns an array containing the numbers of any positive integer keys that have non‐nil values, sorted in numerical order. For example, for the table {{code\|code={'foo', nil, 'bar', 'baz', a = 'b'}\|lang=lua}}, {{code\|numKeys}} will return {{code\|code={1, 3, 4}\|lang=lua}}.		Takes a table {{var\|t}} and returns an array containing the numbers of any positive integer keys that have non‐nil values, sorted in numerical order. For example, for the table {{code\|code={'foo', nil, 'bar', 'baz', a = 'b'}\|lang=lua}}, {{code\|numKeys}} will return {{code\|code={1, 3, 4}\|lang=lua}}.

	== affixNums ==		== affixNums ==