ماڈیول:TableTools/doc
This is the documentation page for ماڈیول:TableTools
This module is rated as alpha. It is ready for third party input, and may be used on a few pages to see if problems arise, but should be watched. Suggestions for new features or changes in their input and output mechanisms are welcome. |
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.
local TableTools = require('Module:TableTools')
isPositiveInteger
سودھو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
سودھو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
سودھو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
سودھو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
removeDuplicates will return {5, 4, 4, 3, 4, 2, 2, 1}
{5, 4, 3, 2, 1}
numKeys
سودھو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
, numKeys will return {'foo', nil, 'bar', 'baz', a = 'b'}
.
{1, 3, 4}
affixNums
سودھو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
and the prefix {a1 = 'foo', a3 = 'bar', a6 = 'baz'}
'a'
, affixNums will return
. All characters in {1, 3, 6}
prefix
and suffix
are interpreted literally.
numData
سودھوTableTools.numData(t, compress)
Given a table with keys like "foo1", "bar1", "foo2", and "baz2", returns a table of subtables in the format
. 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.
{ [1] = {foo = 'text', bar = 'text'}, [2] = {foo = 'text', baz = 'text'} }
compressSparseArray
سودھو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
, compressSparseArray will return {1, nil, foo = 'bar', 3, 2}
.
{1, 3, 2}
sparseIpairs
سودھو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
سودھوTableTools.size(t)
Finds the size of a key/value pair table. For example, for the table
, size will return {foo = 'foo', bar = 'bar'}
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.