Module:TableTools/doc: Difference between revisions
imported>Pppery (→inArray: Document) |
imported>Pppery |
||
Line 142: | Line 142: | ||
TableTools.inArray(arr,valueToFind) | TableTools.inArray(arr,valueToFind) | ||
</source> | </source> | ||
Returns <syntaxhighlight lang="lua">true</syntaxhighlight> if <var>valueToFind</var> is a member of the array <var>arr</var>, and <syntaxhighlight lang="lua">false</syntaxhighlight> otherwise. | Returns <syntaxhighlight lang="lua" enclose="none">true</syntaxhighlight> if <var>valueToFind</var> is a member of the array <var>arr</var>, and <syntaxhighlight lang="lua" enclose="none">false</syntaxhighlight> otherwise. | ||
<includeonly>{{Sandbox other|| | <includeonly>{{Sandbox other|| | ||
[[Category:Lua metamodules|TableTools]] | [[Category:Lua metamodules|TableTools]] | ||
}}</includeonly> | }}</includeonly> |
Revision as of 21:53, 19 February 2019
Warning | This Lua module is used on approximately 6,140,000 pages, or roughly 152850% of all pages. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
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.
Loading the module
To use any of the functions, first you must load the module.
<source lang="lua"> local TableTools = require('Module:TableTools') </source>
isPositiveInteger
<source lang="lua"> TableTools.isPositiveInteger(value) </source>
Returns true
if value
is a positive integer, and false
if not. Although it doesn't operate on tables, it is included here as it is useful for determining whether a given table key is in the array part or the hash part of a table.
isNan
<source lang="lua"> TableTools.isNan(value) </source>
Returns true
if value
is a NaN value, and false
if not. Although it doesn't operate on tables, it is included here as it is useful for determining whether a value can be a valid table key. (Lua will generate an error if a NaN value is used as a table key.)
shallowClone
<source lang="lua"> TableTools.shallowClone(t) </source>
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 mw.clone instead.
removeDuplicates
<source lang="lua"> TableTools.removeDuplicates(t) </source>
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 nil
value. (For arrays containing nil
values, you can use compressSparseArray 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 <syntaxhighlight lang="lua" class="" id="" style="" inline="1">{5, 4, 4, 3, 4, 2, 2, 1}</syntaxhighlight> removeDuplicates will return <syntaxhighlight lang="lua" class="" id="" style="" inline="1">{5, 4, 3, 2, 1}</syntaxhighlight>
numKeys
<source lang="lua"> TableTools.numKeys(t) </source>
Takes a table 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 <syntaxhighlight lang="lua" class="" id="" style="" inline="1">{'foo', nil, 'bar', 'baz', a = 'b'}</syntaxhighlight>, numKeys will return <syntaxhighlight lang="lua" class="" id="" style="" inline="1">{1, 3, 4}</syntaxhighlight>.
affixNums
<source lang="lua"> TableTools.affixNums(t, prefix, suffix) </source>
Takes a table t
and returns an array containing the numbers of keys with the optional prefix prefix
and the optional suffix suffix
. For example, for the table <syntaxhighlight lang="lua" class="" id="" style="" inline="1">{a1 = 'foo', a3 = 'bar', a6 = 'baz'}</syntaxhighlight> and the prefix 'a'
, affixNums will return <syntaxhighlight lang="lua" class="" id="" style="" inline="1">{1, 3, 6}</syntaxhighlight>. All characters in prefix
and suffix
are interpreted literally.
numData
<source lang="lua"> TableTools.numData(t, compress) </source>
Given a table with keys like "foo1", "bar1", "foo2", and "baz2", returns a table of subtables in the format <syntaxhighlight lang="lua" class="" id="" style="" inline="1">{ [1] = {foo = 'text', bar = 'text'}, [2] = {foo = 'text', baz = 'text'} }</syntaxhighlight>. Keys that don't end with an integer are stored in a subtable named "other". The compress option compresses the table so that it can be iterated over with ipairs.
compressSparseArray
<source lang="lua"> TableTools.compressSparseArray(t) </source>
Takes an array 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 ipairs. Any keys that are not positive integers are removed. For example, for the table <syntaxhighlight lang="lua" class="" id="" style="" inline="1">{1, nil, foo = 'bar', 3, 2}</syntaxhighlight>, compressSparseArray will return <syntaxhighlight lang="lua" class="" id="" style="" inline="1">{1, 3, 2}</syntaxhighlight>.
sparseIpairs
<source lang="lua"> TableTools.sparseIpairs(t) </source>
This is an iterator function for traversing a sparse array t
. It is similar to ipairs, but will continue to iterate until the highest numerical key, whereas ipairs may stop after the first nil
value. Any keys that are not positive integers are ignored.
Usually sparseIpairs is used in a generic for
loop.
<source lang="lua"> for i, v in TableTools.sparseIpairs(t) do
-- code block
end </source>
Note that sparseIpairs uses the pairs function in its implementation. Although some table keys appear to be ignored, all table keys are accessed when it is run.
size
<source lang="lua"> TableTools.size(t) </source>
Finds the size of a key/value pair table. For example, for the table <syntaxhighlight lang="lua" class="" id="" style="" inline="1">{foo = 'foo', bar = 'bar'}</syntaxhighlight>, size will return 2
. The function will also work on arrays, but for arrays it is more efficient to use the # operator. Note that to find the table size, this function uses the pairs function to iterate through all of the table keys.
keysToList
<source lang="lua"> TableTools.keysToList(t, keySort) </source> Returns a list of the keys in a table, sorted using either a default comparison function or a custom keySort function.
sortedPairs
<source lang="lua"> TableTools.sortedPairs(t, keySort) </source> Iterates through a table, with the keys sorted using the keysToList function. If there are only numerical keys, sparseIpairs is probably more efficient.
isArray
<source lang="lua"> TableTools.isArray(t) </source> Returns true if all keys in the table are consecutive integers starting at 1.
invert
<source lang="lua"> TableTools.invert(t) </source> Transposes the keys and values in a table.
deepCopy
<source lang="lua"> TableTools.deepCopy(t) </source>
sparseConcat
<source lang="lua"> TableTools.sparseConcat(t) </source> Concatenates all values in the table that are indexed by a number, in order.
length
<source lang="lua"> TableTools.length(t) </source> returns the length of a table, or the first integer key n counting from 1 such that t[n + 1] is nil. 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 #.
inArray
<source lang="lua"> TableTools.inArray(arr,valueToFind) </source> Returns <syntaxhighlight lang="lua" enclose="none">true</syntaxhighlight> if valueToFind is a member of the array arr, and <syntaxhighlight lang="lua" enclose="none">false</syntaxhighlight> otherwise.