TheWaffleLord: Protected "Module:TableTools/doc": Important page ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2023-09-15T03:37:52Z

Protected "Module:TableTools/doc": Important page ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

← Older revision	Revision as of 03:37, 15 September 2023
(No difference)

imported>Pppery: Rv

2023-01-28T17:50:13Z

Show changes

2A02:CB80:4126:8FDF:800A:5E6E:3F0D:CFA6: ←Blanked the page

2023-01-28T17:45:06Z

←Blanked the page

Show changes

imported>Pppery: Suppress inapplicable tracking category

2022-02-21T01:32:01Z

Suppress inapplicable tracking category

← Older revision		Revision as of 01:32, 21 February 2022
Line 1:		Line 1:
	{{used in system}}		{{used in system}}
	{{module rating\|protected}}		{{module rating\|protected}}
	{{lua\|Module:Exponential search}}		{{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.

imported>555: {{lua|Module:Exponential search}}

2022-02-15T20:05:43Z

← Older revision		Revision as of 20:05, 15 February 2022
Line 1:		Line 1:
	{{used in system}}		{{used in system}}
	{{module rating\|protected}}		{{module rating\|protected}}
			{{lua\|Module:Exponential search}}
	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.

imported>Chip3004: Undid revision 1062512603 by 2A02:C7F:521A:C300:4599:F584:145B:268B (talk) Do not blank pages

2021-12-28T22:42:58Z

Undid revision 1062512603 by 2A02:C7F:521A:C300:4599:F584:145B:268B (talk) Do not blank pages

Show changes

2A02:C7F:521A:C300:4599:F584:145B:268B: ←Blanked the page

2021-12-28T22:41:26Z

←Blanked the page

Show changes

imported>Alexiscoutinho: Updated for various functions

2021-10-04T16:49:37Z

Updated for various functions

← Older revision		Revision as of 16:49, 4 October 2021
Line 42:		Line 42:
	</syntaxhighlight>		</syntaxhighlight>

	Removes duplicate values from an array. This function is only designed to work with standard arrays: keys that are not positive integers are ignored, as are all values after the first <code>nil</code> value. (For arrays containing <code>nil</code> values, you can use <code>[[#compressSparseArray\|compressSparseArray]]</code> first.) The function tries to preserve the order of the array: the earliest non-unique value is kept, and all subsequent duplicate values are removed. For example, for the table {{code\|code={5, 4, 4, 3, 4, 2, 2, 1}\|lang=lua}} <code>removeDuplicates</code> will return {{code\|code={5, 4, 3, 2, 1}\|lang=lua}}		Removes duplicate values from an array. This function is only designed to work with standard arrays: keys that are not positive integers are ignored, as are all values after the first <code>nil</code> value. (For arrays containing <code>nil</code> values, you can use <code>[[#compressSparseArray\|compressSparseArray]]</code> first.) The function tries to preserve the order of the array: the earliest non-unique value is kept, and all subsequent duplicate values are removed. For example, for the table {{code\|code={5, 4, 4, 3, 4, 2, 2, 1}\|lang=lua}} <code>removeDuplicates</code> will return {{code\|code={5, 4, 3, 2, 1}\|lang=lua}}.

	== numKeys ==		== numKeys ==
Line 105:		Line 105:

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	TableTools.keysToList(t, keySort)		TableTools.keysToList(t, keySort, checked)
	</syntaxhighlight>		</syntaxhighlight>

	Returns a list of the keys in a table, sorted using either a default comparison function or a custom <code>keySort</code> function, which follows the same rules as the <code>comp</code> function supplied to [[mw:Extension:Scribunto/Lua reference manual#table.sort\|<code>~~table~~.~~sort~~</code>]].		Returns a list of the keys in a table, sorted using either a default comparison function or a custom <code>''keySort''</code> function, which follows the same rules as the <code>comp</code> function supplied to <code>[[mw:Extension:Scribunto/Lua reference manual#table.sort\|table.sort]]</code>. If <code>''keySort''</code> is <code>false</code>, no sorting is done. Set <code>''checked''</code> to <code>true</code> to skip the internal type checking.

	== sortedPairs ==		== sortedPairs ==
Line 121:		Line 121:

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	TableTools.isArray(t)		TableTools.isArray(value)
	</syntaxhighlight>		</syntaxhighlight>

	Returns true if all keys ~~in the table~~ are consecutive integers starting at ~~<code>~~1~~</code>~~.		Returns <code>true</code> if <code>''value''</code> is a table and all keys are consecutive integers starting at 1.

	== ~~listToSet~~ ==		== isArrayLike ==

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	TableTools.~~listToSet~~(~~arr~~)		TableTools.isArrayLike(value)
	</syntaxhighlight>		</syntaxhighlight>

	~~Creates a set from the array part of the table~~ <code>~~arr</code>. Indexing the set by any of the values in <code>arr~~</code> ~~returns~~ <code>~~true~~</code>.		Returns <code>true</code> if <code>''value''</code> is iterable and all keys are consecutive integers starting at 1.

			== invert ==

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~local set =~~ TableTools.~~listToSet { "a", "b", "c" }~~		TableTools.invert(arr)
	~~assert~~(~~set["a"] == true~~)
	</syntaxhighlight>		</syntaxhighlight>

	== ~~invert~~ ==		Transposes the keys and values in an array. For example, {{code\|invert{ "a", "b", "c" }\|lua}} yields {{code\|code={ a=1, b=2, c=3 }\|lang=lua}}.

			== listToSet ==

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	TableTools.~~invert~~(t)		TableTools.listToSet(arr)
	</syntaxhighlight>		</syntaxhighlight>

	~~Transposes~~ the ~~keys and~~ values ~~in an~~ array. For example, <code~~>invert~~{ "a", "b", "c" }</code~~> yields <~~code>{ a = 1, b = 2, c = 3 }~~</code>~~.		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.

	== deepCopy ==		== deepCopy ==
Line 153:		Line 156:
	</syntaxhighlight>		</syntaxhighlight>

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

	Similar to <code>mw.clone</code>, but <code>mw.clone</code> cannot copy tables loaded with <code>mw.loadData</code> and does not allow metatables <em>not</em> to be copied.		Similar to <code>mw.clone</code>, but <code>mw.clone</code> cannot copy tables loaded with <code>mw.loadData</code> and does not allow metatables <em>not</em> to be copied.
Line 160:		Line 163:

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	TableTools.sparseConcat(t, sep)		TableTools.sparseConcat(t, sep, i, j)
	</syntaxhighlight>		</syntaxhighlight>

	Concatenates all values in the table that are indexed by a positive integer, in order.		Concatenates all values in the table that are indexed by a positive integer, in order. For example, {{code\|sparseConcat{ "a", nil, "c", "d" }\|lua}} yields {{code\|"acd"\|lua}} and {{code\|sparseConcat{ nil, "b", "c", "d" }\|lua}} yields {{code\|"bcd"\|lua}}.

	== length ==		== length ==

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	TableTools.length(t)		TableTools.length(t, prefix)
	</syntaxhighlight>		</syntaxhighlight>

	Finds the length of an array, or of a quasi-array with keys such as "data1", "data2", etc. It uses a [[exponential search]] algorithm to find the length, so as to use as few table lookups as possible.		Finds the length of an array or of a quasi-array with keys with an optional <code>''prefix''</code> such as "data1", "data2", etc. It uses an [[exponential search]] algorithm to find the length, so as to use as few table lookups as possible.

	This algorithm is useful for arrays that use metatables (e.g. [[mw:Extension:Scribunto/Lua reference manual#frame.args\|frame.args]]) and for quasi-arrays. For normal arrays, just use the [[mw:Extension:Scribunto/Lua reference manual#Length operator\|# operator]], as it is implemented in [[C (programming language)\|C]] and will be quicker.		This algorithm is useful for arrays that use metatables (e.g. [[mw:Extension:Scribunto/Lua reference manual#frame.args\|frame.args]]) and for quasi-arrays. For normal arrays, just use the [[mw:Extension:Scribunto/Lua reference manual#Length operator\|# operator]], as it is implemented in [[C (programming language)\|C]] and will be quicker.
Line 181:		Line 184:
	</syntaxhighlight>		</syntaxhighlight>

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

	<includeonly>{{Sandbox other\|\|		<includeonly>{{Sandbox other\|\|
	[[Category:Lua metamodules\|TableTools]]		[[Category:Lua metamodules\|TableTools]]
	}}</includeonly>		}}</includeonly>

imported>MerelyPumpkin: Reverted 1 edit by 64.57.49.106 (talk): Unexplained blanking

2021-05-17T20:38:42Z

Reverted 1 edit by 64.57.49.106 (talk): Unexplained blanking

Show changes

64.57.49.106: ←Blanked the page

2021-05-17T20:37:15Z

←Blanked the page

Show changes

Module:TableTools/doc - Revision history

TheWaffleLord: Protected "Module:TableTools/doc": Important page ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

imported>Pppery: Rv

2A02:CB80:4126:8FDF:800A:5E6E:3F0D:CFA6: ←Blanked the page

imported>Pppery: Suppress inapplicable tracking category

imported>555: {{lua|Module:Exponential search}}

imported>Chip3004: Undid revision 1062512603 by 2A02:C7F:521A:C300:4599:F584:145B:268B (talk) Do not blank pages

2A02:C7F:521A:C300:4599:F584:145B:268B: ←Blanked the page

imported>Alexiscoutinho: Updated for various functions

imported>MerelyPumpkin: Reverted 1 edit by 64.57.49.106 (talk): Unexplained blanking

64.57.49.106: ←Blanked the page