Editing Module:TableTools/doc

{{high-risk|1,000,000+}}
{{module rating|beta}}

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 <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.

== isNan ==

<source lang="lua">
TableTools.isNan(value)
</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.)

== 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:Extension:Scribunto/Lua reference manual#mw.clone|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 <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}}

== numKeys ==

<source lang="lua">
TableTools.numKeys(t)
</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}}.

== affixNums ==

<source lang="lua">
TableTools.affixNums(t, prefix, suffix)
</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.

== 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 {{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.

== compressSparseArray ==

<source lang="lua">
TableTools.compressSparseArray(t)
</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}}.

== sparseIpairs ==

<source lang="lua">
TableTools.sparseIpairs(t)
</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.

Usually sparseIpairs is used in a generic <code>for</code> loop.

<source lang="lua">
for i, v in TableTools.sparseIpairs(t) do
   -- code block
end
</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.

== size ==

<source lang="lua">
TableTools.size(t)
</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||
[[Category:Lua metamodules|TableTools, {{PAGENAME}}]]
}}</includeonly>