Module:TableTools/doc

本模块文档以及对应的页面是从维基百科的Module:TableTools/doc页面搬运过来的。

由于滚动的天空Wiki所需的模板、模块缺少，且一些特征与维基百科不同，因此不一定会完全兼容。

本模块文档在搬运时，进行了以下修改：

1. 修改了isNan函数，使之效率更高。
2. 由于没有引入指数搜索模块，暂时不能使用length函数。
3. 增加了一部分函数。

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

加载模块

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

local TableTools = require('Module:TableTools')

isPositiveInteger

TableTools.isPositiveInteger(value)

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

isNan

TableTools.isNan(value)

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

shallowClone

TableTools.shallowClone(t)

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

shallowCloneArray

TableTools.shallowCloneArray(t)

返回数组的副本。返回的值是一个新的数组类似于shallowClone，但是只会复制数组部分。

rawShallowClone

TableTools.rawShallowClone(t)

类似于TableTools.shallowClone，但是迭代时会绕过__pairs元表。

appendAll

TableTools.appendAll(t, anotherArray)

在数组t的末尾添加数组anotherArray的所有内容。会修改t，不返回值。

removeDuplicates

TableTools.removeDuplicates(t)

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

numKeys

TableTools.numKeys(t)

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

allNumKeys

TableTools.allNumKeys(t)

类似于numKeys，但是不限于正整数。

affixNums

TableTools.affixNums(t, prefix, suffix)

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

allAffixNums

TableTools.allAffixNums(t, prefix, suffix)

类似于affixNums，但是不限于正整数。

numData

TableTools.numData(t, compress)

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

allPrefixedNumKeys

TableTools.allPrefixedNumKeys(t, pattern)

假设有{a1 = 'a1', a2 = 'a2', a3 = 'a3', b1 = 'b1', b2 = 'b2'}这样的表，返回{a = {'a1', 'a2', 'a3'}, b = {'b1', 'b2'} }这样的表。非以数字结尾的表会被忽略，且该表的子表可能是稀疏数组。

pattern用于指定正则表达式匹配。例如，若pattern为'^(category)(.+)$'只会匹配以“category”开头，任意数字（可以是小数、负数）结尾的部分。这个正则表达式需要捕获两个值，第一个值是前缀，即返回的表的键，第二个值是可能是数字的部分，应当有可能用tonumber转化为数字。

compressSparseArray

TableTools.compressSparseArray(t)

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

compressExtendedSparseArray

TableTools.compressExtendedSparseArray(t)

类似于compressSparseArray，但是不会移除非正整数键和小数键。

sparseIpairs

TableTools.sparseIpairs(t)

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

sparseIpairs常用于通用的for循环。

for i, v in TableTools.sparseIpairs(t) do
   -- 代码
end

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

extendedSparseIpairs

TableTools.extendedSparseIpairs(t)

类似于sparseIpairs，但是不会忽略非正整数键和小数键。

size

TableTools.size(t)

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

rawSize

TableTools.rawSize(t)

类似于size，但是会忽略__pairs元方法。

keysToList

TableTools.keysToList(t, keySort)

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

rawKeysToList

TableTools.rawKeysToList(t, keySort)

类似于keysToList，但是会忽略__pairs元方法。

sortedPairs

TableTools.sortedPairs(t, keySort)

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

该函数不能作为表的__pairs元方法，否则会出现堆栈溢出。

rawSortedPairs

TableTools.rawSortedPairs(t, keySort)

类似于rawSortedPairs，但是会忽略__pairs元方法，可以作为表的__pairs元方法。

isArray

TableTools.isArray(t)

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

listToSet

TableTools.listToSet(arr)

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

local set = TableTools.listToSet { "a", "b", "c" }
assert(set["a"] == true)

invert

TableTools.invert(t)

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

deepCopy

TableTools.deepCopy(orig, noMetatable, alreadySeen)

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

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

sparseConcat

TableTools.sparseConcat(t, sep)

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

inArray

TableTools.inArray(arr, valueToFind)

如果valueToFind是数组arr的成员，返回true，否则返回false。