模組:TableTools/doc
此頁面為 Module:TableTools 的說明文件
本模塊包含一系列用於處理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。