Module:TableTools/doc

本模块包含一系列用于处理Lua表的函数。这是个元模块，用于其他Lua模块调用，而不应该由#invoke直接调用。

加载模块

如需加载任何函数，首先需要加载模块。

<syntaxhighlight lang="lua"> local TableTools = require('Module:TableTools') </syntaxhighlight>

isPositiveInteger

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

如果value是正整数，返回true，否则返回false。虽然此函数不是应用于表的，但这里仍收录了此函数以决定一个给定的键是否在表的数组部分或哈希部分。

isNan

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

如果value是NaN值，返回true，否则返回false。虽然此函数不是应用于表的，但这里仍收录了此函数以决定一个值能否作为有效的键。（将NaN作为键会报错。）

shallowClone

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

返回表格的副本。返回的值是一个新表，但是所有的子表和函数都会共用。不会绕过元表，但返回的表自身不会带有元表。如需在创建新表时不共享子表格且要复制元表，可以使用mw.clone。

removeDuplicates

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

从数组中返回重复值。此函数仅用于标准的数组，所有非正整数键的一律忽略，第一个nil后的值也会忽略。（对于包含nil的数组，可以先使用compressSparseArray。）此函数尝试保护数组的顺序：有重复值时，仅保留最早出现的那个。例如，对于表<syntaxhighlight lang="lua" inline="">{5, 4, 4, 3, 4, 2, 2, 1}</syntaxhighlight>，removeDuplicates返回<syntaxhighlight lang="lua" inline="">{5, 4, 3, 2, 1}</syntaxhighlight>。

numKeys

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

接收表t并以数字顺序返回拥有非nil值的正整数键的数量。例如，对于<syntaxhighlight lang="lua" inline="">{'foo', nil, 'bar', 'baz', a = 'b'}</syntaxhighlight>，numKeys返回<syntaxhighlight lang="lua" inline="">{1, 3, 4}</syntaxhighlight>。

affixNums

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

接收表t并返回包含含有可选前缀prefix和可选后缀suffix的键的数量的数组。例如，对于表<syntaxhighlight lang="lua" inline="">{a1 = 'foo', a3 = 'bar', a6 = 'baz'}</syntaxhighlight>和前缀'a'，affixNums返回<syntaxhighlight lang="lua" inline="">{1, 3, 6}</syntaxhighlight>。prefix和suffix的值均按字面解释（不使用正则表达式）。

numData

<syntaxhighlight lang="lua"> TableTools.numData(t, compress) </syntaxhighlight>

假如一个表有像foo1、bar1、foo2、baz2这样的键，返回如下格式的子表的表<syntaxhighlight lang="lua" inline="">{ [1] = {foo = 'text', bar = 'text'}, [2] = {foo = 'text', baz = 'text'} }</syntaxhighlight>。不以整数结尾的键存储在命名为other的子表中。compress选项会压缩表以便通过ipairs迭代。

compressSparseArray

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

接收一个带有一个或更多nil值的数组t，移除所有的nil值，不影响其他值的顺序，以便于安全地通过ipairs遍历。所有非正整数的键都会移除。例如，对于表<syntaxhighlight lang="lua" inline="">{1, nil, foo = 'bar', 3, 2}</syntaxhighlight>，compressSparseArray返回<syntaxhighlight lang="lua" inline="">{1, 3, 2}</syntaxhighlight>。

sparseIpairs

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

这是用于遍历稀疏数组t的迭代器函数。类似于ipairs，但会一直迭代直到最高的数字键，而ipairs遇到第一个nil就可能会终止。忽略所有的非正整数键。

sparseIpairs常用于通用的for循环。

<syntaxhighlight lang="lua"> for i, v in TableTools.sparseIpairs(t) do

  -- 代码

end </syntaxhighlight>

注意sparseIpairs会在实现时使用pairs。尽管一些键看上去被忽略，但实际上运行时也会遍历到。

size

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

寻找“键/值对”表的大小。例如，对于<syntaxhighlight lang="lua" inline="">{foo = 'foo', bar = 'bar'}</syntaxhighlight>，size返回2。函数也可以用于数组，但是对于数组，使用#操作符更高效。注意，为了查找表的大小，函数会使用pairs函数以遍历所有的表键。

keysToList

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

返回表的键的列表，并按默认比较函数或者自定义keySort函数排序，与table.sort的comp函数类似。

sortedPairs

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

迭代表，并使用keysToList函数来排序键。如果只有数字键，sparseIpairs可能更高效。

isArray

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

如果表中的所有键都是以1开始的接连不断的整数，返回true。

listToSet

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

从表arr的数组部分创建一个集（set）。用arr的任何值来索引集都会返回true。

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

invert

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

交换数组中的键和值。例如，invert{ "a", "b", "c" }产生{ a = 1, b = 2, c = 3 }。

deepCopy

<syntaxhighlight lang="lua"> TableTools.deepCopy(orig, noMetatable, alreadySeen) </syntaxhighlight>

返回表orig的副本，类似于mw.clone，所有非函数的值都会复制，并保留表的唯一性。如果noMetatable为true，则不会复制元表（如有）。可以复制由mw.loadData加载的表。

与mw.clone类似，但mw.clone不能够复制由mw.loadData加载的表，也不允许拒绝复制元表。

sparseConcat

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

按顺序连接被正整数索引的表的所有值。

length

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

查找数组的长度，或者带有像data1、data2这样的键的准数组。使用指数搜索算法以查找长度，以便于尽可能少地使用表查找（table lookup）。

对于准数组，此算法对使用元表的数组有用（例如frame.args）。对于正常数组，只需要使用#操作符，因为#操作符是由C语言实现的，速度更快。

inArray

<syntaxhighlight lang="lua"> TableTools.inArray(arr, valueToFind) </syntaxhighlight>

如果valueToFind是数组arr的成员，返回<syntaxhighlight lang="lua" inline>true</syntaxhighlight>，否则返回<syntaxhighlight lang="lua" inline>false</syntaxhighlight>。