Munurin millum rættingarnar hjá "Module:TableTools/doc"
EileenSanda (kjak | íkøst) Stovnaði síðu við " 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..." |
s Bot: Erstatt forældet <source> -tag og parameteren "enclose" [https://lists.wikimedia.org/pipermail/wikitech-ambassadors/2020-April/002284.html] |
||
Linja 6: | Linja 6: | ||
To use any of the functions, first you must load the module. |
To use any of the functions, first you must load the module. |
||
< |
<syntaxhighlight lang="lua"> |
||
local TableTools = require('Module:TableTools') |
local TableTools = require('Module:TableTools') |
||
</syntaxhighlight> |
|||
</source> |
|||
== isPositiveInteger == |
== isPositiveInteger == |
||
< |
<syntaxhighlight lang="lua"> |
||
TableTools.isPositiveInteger(value) |
TableTools.isPositiveInteger(value) |
||
</syntaxhighlight> |
|||
</source> |
|||
Returns <code>true</code> if <code>''value''</code> is a positive integer, and <code>false</code> 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. |
Returns <code>true</code> if <code>''value''</code> is a positive integer, and <code>false</code> 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. |
||
Linja 20: | Linja 20: | ||
== isNan == |
== isNan == |
||
< |
<syntaxhighlight lang="lua"> |
||
TableTools.isNan(value) |
TableTools.isNan(value) |
||
</syntaxhighlight> |
|||
</source> |
|||
Returns <code>true</code> if <code>''value''</code> is a NaN value, and <code>false</code> 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.) |
Returns <code>true</code> if <code>''value''</code> is a NaN value, and <code>false</code> 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.) |
||
Linja 28: | Linja 28: | ||
== shallowClone == |
== shallowClone == |
||
< |
<syntaxhighlight lang="lua"> |
||
TableTools.shallowClone(t) |
TableTools.shallowClone(t) |
||
</syntaxhighlight> |
|||
</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:Extension:Scribunto/Lua reference manual#mw.clone|mw.clone]] instead. |
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:Extension:Scribunto/Lua reference manual#mw.clone|mw.clone]] instead. |
||
Linja 36: | Linja 36: | ||
== removeDuplicates == |
== removeDuplicates == |
||
< |
<syntaxhighlight lang="lua"> |
||
TableTools.removeDuplicates(t) |
TableTools.removeDuplicates(t) |
||
</syntaxhighlight> |
|||
</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 <code>nil</code> value. (For arrays containing <code>nil</code> values, you can use [[#compressSparseArray|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 {{code|code={5, 4, 4, 3, 4, 2, 2, 1}|lang=lua}} removeDuplicates 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 [[#compressSparseArray|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 {{code|code={5, 4, 4, 3, 4, 2, 2, 1}|lang=lua}} removeDuplicates will return {{code|code={5, 4, 3, 2, 1}|lang=lua}} |
||
Linja 44: | Linja 44: | ||
== numKeys == |
== numKeys == |
||
< |
<syntaxhighlight lang="lua"> |
||
TableTools.numKeys(t) |
TableTools.numKeys(t) |
||
</syntaxhighlight> |
|||
</source> |
|||
Takes a table <code>''t''</code> 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}}, numKeys will return {{code|code={1, 3, 4}|lang=lua}}. |
Takes a table <code>''t''</code> 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}}, numKeys will return {{code|code={1, 3, 4}|lang=lua}}. |
||
Linja 52: | Linja 52: | ||
== affixNums == |
== affixNums == |
||
< |
<syntaxhighlight lang="lua"> |
||
TableTools.affixNums(t, prefix, suffix) |
TableTools.affixNums(t, prefix, suffix) |
||
</syntaxhighlight> |
|||
</source> |
|||
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>, affixNums 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>, affixNums will return {{code|code={1, 3, 6}|lang=lua}}. All characters in <code>''prefix''</code> and <code>''suffix''</code> are interpreted literally. |
||
Linja 60: | Linja 60: | ||
== numData == |
== numData == |
||
< |
<syntaxhighlight lang="lua"> |
||
TableTools.numData(t, compress) |
TableTools.numData(t, compress) |
||
</syntaxhighlight> |
|||
</source> |
|||
Given a table with keys like "foo1", "bar1", "foo2", and "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 "other". The compress option compresses the table so that it can be iterated over with ipairs. |
Given a table with keys like "foo1", "bar1", "foo2", and "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 "other". The compress option compresses the table so that it can be iterated over with ipairs. |
||
Linja 68: | Linja 68: | ||
== compressSparseArray == |
== compressSparseArray == |
||
< |
<syntaxhighlight lang="lua"> |
||
TableTools.compressSparseArray(t) |
TableTools.compressSparseArray(t) |
||
</syntaxhighlight> |
|||
</source> |
|||
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 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}}, compressSparseArray 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 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}}, compressSparseArray will return {{code|code={1, 3, 2}|lang=lua}}. |
||
Linja 76: | Linja 76: | ||
== sparseIpairs == |
== sparseIpairs == |
||
< |
<syntaxhighlight lang="lua"> |
||
TableTools.sparseIpairs(t) |
TableTools.sparseIpairs(t) |
||
</syntaxhighlight> |
|||
</source> |
|||
This is an iterator function for traversing a sparse array <code>''t''</code>. It is similar to [[mw:Extension:Scribunto/Lua reference manual#ipairs|ipairs]], but will continue to iterate until the highest numerical key, whereas ipairs may stop after the first <code>nil</code> value. Any keys that are not positive integers are ignored. |
This is an iterator function for traversing a sparse array <code>''t''</code>. It is similar to [[mw:Extension:Scribunto/Lua reference manual#ipairs|ipairs]], but will continue to iterate until the highest numerical key, whereas ipairs may stop after the first <code>nil</code> value. Any keys that are not positive integers are ignored. |
||
Linja 84: | Linja 84: | ||
Usually sparseIpairs is used in a generic <code>for</code> loop. |
Usually sparseIpairs is used in a generic <code>for</code> loop. |
||
< |
<syntaxhighlight lang="lua"> |
||
for i, v in TableTools.sparseIpairs(t) do |
for i, v in TableTools.sparseIpairs(t) do |
||
-- code block |
-- code block |
||
end |
end |
||
</syntaxhighlight> |
|||
</source> |
|||
Note that sparseIpairs uses the [[mw:Extension:Scribunto/Lua reference manual#pairs|pairs]] function in its implementation. Although some table keys appear to be ignored, all table keys are accessed when it is run. |
Note that sparseIpairs uses the [[mw:Extension:Scribunto/Lua reference manual#pairs|pairs]] function in its implementation. Although some table keys appear to be ignored, all table keys are accessed when it is run. |
||
Linja 94: | Linja 94: | ||
== size == |
== size == |
||
< |
<syntaxhighlight lang="lua"> |
||
TableTools.size(t) |
TableTools.size(t) |
||
</syntaxhighlight> |
|||
</source> |
|||
Finds the size of a key/value pair table. For example, for the table {{code|code={foo = 'foo', bar = 'bar'}|lang=lua}}, size will return <code>2</code>. 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 [[mw:Extension:Scribunto/Lua reference manual#pairs|pairs]] function to iterate through all of the table keys.<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|| |
Finds the size of a key/value pair table. For example, for the table {{code|code={foo = 'foo', bar = 'bar'}|lang=lua}}, size will return <code>2</code>. 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 [[mw:Extension:Scribunto/Lua reference manual#pairs|pairs]] function to iterate through all of the table keys.<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|| |
Seinasta endurskoðan sum var 22. apr 2020 kl. 16:39
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
[rætta wikitekst]To use any of the functions, first you must load the module.
local TableTools = require('Module:TableTools')
isPositiveInteger
[rætta wikitekst]TableTools.isPositiveInteger(value)
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
[rætta wikitekst]TableTools.isNan(value)
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
[rætta wikitekst]TableTools.shallowClone(t)
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
[rætta wikitekst]TableTools.removeDuplicates(t)
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
{5, 4, 4, 3, 4, 2, 2, 1}
removeDuplicates will return
{5, 4, 3, 2, 1}
numKeys
[rætta wikitekst]TableTools.numKeys(t)
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
{'foo', nil, 'bar', 'baz', a = 'b'}
, numKeys will return
{1, 3, 4}
.
affixNums
[rætta wikitekst]TableTools.affixNums(t, prefix, suffix)
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
{a1 = 'foo', a3 = 'bar', a6 = 'baz'}
and the prefix 'a'
, affixNums will return
{1, 3, 6}
. All characters in prefix
and suffix
are interpreted literally.
numData
[rætta wikitekst]TableTools.numData(t, compress)
Given a table with keys like "foo1", "bar1", "foo2", and "baz2", returns a table of subtables in the format
{ [1] = {foo = 'text', bar = 'text'}, [2] = {foo = 'text', baz = 'text'} }
. 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
[rætta wikitekst]TableTools.compressSparseArray(t)
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
{1, nil, foo = 'bar', 3, 2}
, compressSparseArray will return
{1, 3, 2}
.
sparseIpairs
[rætta wikitekst]TableTools.sparseIpairs(t)
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.
for i, v in TableTools.sparseIpairs(t) do
-- code block
end
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
[rætta wikitekst]TableTools.size(t)
Finds the size of a key/value pair table. For example, for the table
{foo = 'foo', bar = 'bar'}
, 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.