Toggle search
Toggle menu
15
236
90
27.9K
Kenshi Wiki
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

Module:TableTools/doc: Difference between revisions

From Kenshi Wiki
More actions
VisualWikitext
Prd (talk | contribs)
Bureaucrats, Comment administrators, Forum administrators, Interface administrators, PageProperties admin, PageProperties editor, Push subscription managers, smwadministrator, smwcurator, smweditor, staff, Administrators, Widget editors
21,798 edits
Created page with "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. == Module Quality == {{ModuleQuality}} == Loading the module == To use any of the functions, first you must load the module. <syntaxhighlight lang="lua"> local TableTools = require('Module:TableTools') </syntaxhighlight> == Functions == === isPositiveInteger === <syntaxhighlight lang=..."
 
Prd (talk | contribs)
Bureaucrats, Comment administrators, Forum administrators, Interface administrators, PageProperties admin, PageProperties editor, Push subscription managers, smwadministrator, smwcurator, smweditor, staff, Administrators, Widget editors
21,798 edits
No edit summary
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
This module includes a number of functions for dealing with Lua tables.
{{doc sub}}
It is a meta-module, meant to be called from other Lua modules, and should not be called directly from #invoke.
{{lua|Module:Exponential search|noprotcat=yes}}
 
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.
== Module Quality ==
{{ModuleQuality}}


== Loading the module ==
== Loading the module ==
Line 13: Line 11:
</syntaxhighlight>
</syntaxhighlight>


== Functions ==
== isPositiveInteger ==
=== isPositiveInteger ===


<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
Line 20: Line 17:
</syntaxhighlight>
</syntaxhighlight>


Returns <code>true</code> if <code>''value''</code> is a positive integer, and <code>false</code> if not.
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.
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 ===
== isNan ==


<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
Line 29: Line 25:
</syntaxhighlight>
</syntaxhighlight>


Returns <code>true</code> if <code>''value''</code> is a [[NaN]] value, and <code>false</code> if not.
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.)
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 ===
== shallowClone ==


<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
Line 39: Line 33:
</syntaxhighlight>
</syntaxhighlight>


Returns a clone of a table.
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 <code>[[mw:Extension:Scribunto/Lua reference manual#mw.clone|mw.clone]]</code> instead. If you want to make a new table with no shared subtables and without metatables transferred, use <code>[[#deepCopy|deepCopy]]</code> with the <code>noMetatable</code> option.
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 <code>[[mw:Special:MyLanguage/Extension:Scribunto/Lua reference manual#mw.clone|mw.clone]]</code> instead.
If you want to make a new table with no shared subtables and without metatables transferred, use <code>[[#deepCopy|deepCopy]]</code> with the <code>noMetatable</code> option.


=== removeDuplicates ===
== removeDuplicates ==


<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
Line 51: Line 41:
</syntaxhighlight>
</syntaxhighlight>


Removes duplicate values from an array.
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 <code>[[#compressSparseArray|compressSparseArray]]</code> 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}} <code>removeDuplicates</code> will return {{code|code={5, 4, 3, 2, 1}|lang=lua}}.
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 <code>[[#compressSparseArray|compressSparseArray]]</code> 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 <syntaxhighlight lang="lua">{5, 4, 4, 3, 4, 2, 2, 1}</syntaxhighlight> <code>removeDuplicates</code> will return <syntaxhighlight lang="lua">{5, 4, 3, 2, 1}</syntaxhighlight>


=== numKeys ===
== numKeys ==


<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
Line 62: Line 49:
</syntaxhighlight>
</syntaxhighlight>


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.
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}}, <code>numKeys</code> will return {{code|code={1, 3, 4}|lang=lua}}.
For example, for the table <syntaxhighlight lang="lua">{'foo', nil, 'bar', 'baz', a = 'b'}</syntaxhighlight>, <code>numKeys</code> will return <syntaxhighlight lang="lua">{1, 3, 4}</syntaxhighlight>.


=== affixNums ===
== affixNums ==


<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
Line 71: Line 57:
</syntaxhighlight>
</syntaxhighlight>


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>.
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>, <code>affixNums</code> will return {{code|code={1, 3, 6}|lang=lua}}. All characters in <code>''prefix''</code> and <code>''suffix''</code> are interpreted literally.
For example, for the table <syntaxhighlight lang="lua">{a1 = 'foo', a3 = 'bar', a6 = 'baz'}</syntaxhighlight> and the prefix <code>'a'</code>, <code>affixNums</code> will return <syntaxhighlight lang="lua">{1, 3, 6}</syntaxhighlight>.
All characters in <code>''prefix''</code> and <code>''suffix''</code> are interpreted literally.


=== numData ===
== numData ==


<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
Line 81: Line 65:
</syntaxhighlight>
</syntaxhighlight>


Given a table with keys like <code>"foo1"</code>, <code>"bar1"</code>, <code>"foo2"</code>, and <code>"baz2"</code>, returns a table of subtables in the format <syntaxhighlight lang="lua">{ [1] = {foo = 'text', bar = 'text'}, [2] = {foo = 'text', baz = 'text'} }</syntaxhighlight>.
Given a table with keys like <code>"foo1"</code>, <code>"bar1"</code>, <code>"foo2"</code>, and <code>"baz2"</code>, 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 <code>"other"</code>. The compress option compresses the table so that it can be iterated over with <code>ipairs</code>.
Keys that don't end with an integer are stored in a subtable named <code>"other"</code>.
The compress option compresses the table so that it can be iterated over with <code>ipairs</code>.


=== compressSparseArray ===
== compressSparseArray ==


<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
Line 91: Line 73:
</syntaxhighlight>
</syntaxhighlight>


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 <code>ipairs</code>.
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 <code>ipairs</code>. Any keys that are not positive integers are removed. For example, for the table {{code|code={1, nil, foo = 'bar', 3, 2}|lang=lua}}, <code>compressSparseArray</code> will return {{code|code={1, 3, 2}|lang=lua}}.
Any keys that are not positive integers are removed.
For example, for the table <syntaxhighlight lang="lua">{1, nil, foo = 'bar', 3, 2}</syntaxhighlight>, <code>compressSparseArray</code> will return <syntaxhighlight lang="lua">{1, 3, 2}</syntaxhighlight>.


=== sparseIpairs ===
== sparseIpairs ==


<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
Line 101: Line 81:
</syntaxhighlight>
</syntaxhighlight>


This is an iterator function for traversing a sparse array <code>''t''</code>.
This is an iterator function for traversing a sparse array <code>''t''</code>. It is similar to <code>[[mw:Extension:Scribunto/Lua reference manual#ipairs|ipairs]]</code>, but will continue to iterate until the highest numerical key, whereas <code>ipairs</code> may stop after the first <code>nil</code> value. Any keys that are not positive integers are ignored.
It is similar to <code>[[mw:Special:MyLanguage/Extension:Scribunto/Lua reference manual#ipairs|ipairs]]</code>, but will continue to iterate until the highest numerical key, whereas <code>ipairs</code> may stop after the first <code>nil</code> value.
Any keys that are not positive integers are ignored.


Usually <code>sparseIpairs</code> is used in a generic <code>for</code> loop.
Usually <code>sparseIpairs</code> is used in a generic <code>for</code> loop.
Line 113: Line 91:
</syntaxhighlight>
</syntaxhighlight>


Note that <code>sparseIpairs</code> uses the <code>[[mw:Special:MyLanguage/Extension:Scribunto/Lua reference manual#pairs|pairs]]</code> function in its implementation.
Note that <code>sparseIpairs</code> uses the <code>[[mw:Extension:Scribunto/Lua reference manual#pairs|pairs]]</code> function in its implementation. Although some table keys appear to be ignored, all table keys are accessed when it is run.
Although some table keys appear to be ignored, all table keys are accessed when it is run.


=== size ===
== size ==


<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
Line 122: Line 99:
</syntaxhighlight>
</syntaxhighlight>


Finds the size of a key/value pair table.
Finds the size of a key/value pair table ([[associative array]]). For example, for {{code|code={foo = 'foo', bar = 'bar'}|lang=lua}}, <code>size</code> will return <code>2</code>. The function will also work on arrays, but for arrays it is more efficient to use the <code>#</code> operator. Note that to find the size, this function uses the <code>[[mw:Extension:Scribunto/Lua reference manual#pairs|pairs]]</code> function to iterate through all of the keys.
For example, for the table <syntaxhighlight lang="lua">{foo = 'foo', bar = 'bar'}</syntaxhighlight>, <code>size</code> will return <code>2</code>.
The function will also work on arrays, but for arrays it is more efficient to use the <code>#</code> operator.
Note that to find the table size, this function uses the <code>[[mw:Special:MyLanguage/Extension:Scribunto/Lua reference manual#pairs|pairs]]</code> function to iterate through all of the table keys.


=== keysToList ===
== keysToList ==


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


Returns a list of the keys in a table, sorted using either a default comparison function or a custom <code>keySort</code> function, which follows the same rules as the <code>comp</code> function supplied to <code>{{ll|Extension:Scribunto/Lua reference manual#table.sort|table.sort}}</code>.
Returns a list of the keys in a table, sorted using either a default comparison function or a custom <code>''keySort''</code> function, which follows the same rules as the <code>comp</code> function supplied to <code>[[mw:Extension:Scribunto/Lua reference manual#table.sort|table.sort]]</code>. If <code>''keySort''</code> is <code>false</code>, no sorting is done. Set <code>''checked''</code> to <code>true</code> to skip the internal type checking.


=== sortedPairs ===
== sortedPairs ==


<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
Line 141: Line 115:
</syntaxhighlight>
</syntaxhighlight>


Iterates through a table, with the keys sorted using the <code>keysToList</code> function.
Iterates through a table, with the keys sorted using the <code>keysToList</code> function. If there are only numerical keys, <code>sparseIpairs</code> is probably more efficient.
If there are only numerical keys, <code>sparseIpairs</code> is probably more efficient.


=== isArray ===
== isArray ==


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


Returns true if all keys in the table are consecutive integers starting at <code>1</code>.
Returns <code>true</code> if <code>''value''</code> is a table and all keys are consecutive integers starting at 1.


=== listToSet ===
== isArrayLike ==


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


Creates a set from the array part of the table <code>arr</code>.
Returns <code>true</code> if <code>''value''</code> is iterable and all keys are consecutive integers starting at 1.
Indexing the set by any of the values in <code>arr</code> returns <code>true</code>.
 
== invert ==


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


=== invert ===
Transposes the keys and values in an array. For example, {{code|invert{ "a", "b", "c" }|lua}} yields {{code|code={ a=1, b=2, c=3 }|lang=lua}}.
 
== listToSet ==


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


Transposes the keys and values in an array.
Creates a set from the array part of the table <code>''arr''</code>. Indexing the set by any of the values of the array returns <code>true</code>. For example, {{code|listToSet{ "a", "b", "c" }|lua}} yields {{code|code={ a=true, b=true, c=true }|lang=lua}}.
For example, <code>invert{ "a", "b", "c" }</code> yields <code>{ a = 1, b = 2, c = 3 }</code>.


=== deepCopy ===
== deepCopy ==


<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
Line 181: Line 155:
</syntaxhighlight>
</syntaxhighlight>


Creates a copy of the table <code>orig</code>.
Creates a copy of the table <code>''orig''</code>. As with <code>mw.clone</code>, all values that are not functions are duplicated and the identity of tables is preserved. If <code>''noMetatable''</code> is <code>true</code>, then the metatable (if any) is not copied. Can copy tables loaded with <code>mw.loadData</code>.
As with <code>mw.clone</code>, all values that are not functions are duplicated and the identity of tables is preserved.
If <code>noMetatable</code> is <code>true</code>, then the metatable (if any) is not copied.
Can copy tables loaded with <code>mw.loadData</code>.


Similar to <code>mw.clone</code>, but <code>mw.clone</code> cannot copy tables loaded with <code>mw.loadData</code> and does not allow metatables <em>not</em> to be copied.
Similar to <code>mw.clone</code>, but <code>mw.clone</code> cannot copy tables loaded with <code>mw.loadData</code> and does not allow metatables <em>not</em> to be copied.


=== sparseConcat ===
== sparseConcat ==
 
<syntaxhighlight lang="lua">
TableTools.sparseConcat(t, sep, i, j)
</syntaxhighlight>
 
Concatenates all values in the table that are indexed by a positive integer, in order. For example, {{code|sparseConcat{ "a", nil, "c", "d" }|lua}} yields {{code|"acd"|lua}} and {{code|sparseConcat{ nil, "b", "c", "d" }|lua}} yields {{code|"bcd"|lua}}.
 
== length ==


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


Concatenates all values in the table that are indexed by a positive integer, in order.
Finds the length of an array or of a quasi-array with keys with an optional <code>''prefix''</code> such as "data1", "data2", etc. It uses an [[exponential search]] algorithm to find the length, so as to use as few table lookups as possible.
 
This algorithm is useful for arrays that use metatables (e.g. [[mw:Extension:Scribunto/Lua reference manual#frame.args|frame.args]]) and for quasi-arrays. For normal arrays, just use the [[mw:Extension:Scribunto/Lua reference manual#Length operator|# operator]], as it is implemented in [[C (programming language)|C]] and will be quicker.
 
== inArray ==
 
<syntaxhighlight lang="lua">TableTools.inArray(array, searchElement)
TableTools.inArray(array, searchElement, fromIndex)</syntaxhighlight>
 
Returns <code>true</code> if <code>''searchElement''</code> is a member of the array <code>''array''</code>, and <code>false</code> otherwise. Equivalent to the javascript [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/includes Array.prototype.includes()] function, except fromIndex is 1-indexed instead of zero-indexed.
 
=== fromIndex ===
<code>fromIndex</code> is the optional 1-based index at which to start searching. If <code>fromIndex</code> is not present, all values in the array will be searched and the array will be treated as a table/[[associative array]] (it will be iterated over using <syntaxhighlight lang="lua" inline>pairs()</syntaxhighlight>).
 
If <code>fromIndex</code> is present and an integer, the array is assumed to be a conventional array/sequence/list (indexed with consecutive integer keys starting at <code>1</code>, and interated over using <syntaxhighlight lang="lua" inline>ipairs()</syntaxhighlight>). Only the values whose index is <code>fromIndex</code> or higher will be searched.


=== length ===
In the following examples, <code>#array</code> represents the length of the integer-keyed portion of the array.
 
* If <code>fromIndex < 0</code> it will count back from the end of the array, e.g. a value of <code>-1</code> will only search the last integer-keyed element in the array. If <code>fromIndex <= (-1 * #array)</code>, the entire integer-keyed portion of the array will be searched.
* If <code>fromIndex = 0</code> it will be treated as a <code>1</code> and the entire integer-keyed portion of the array will be searched.
* If <code>fromIndex > #array</code>, the array is not searched and <code>false</code> is returned.
 
== merge ==


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


Returns the length of a table, or the first integer key <code>n</code> counting from <code>0</code> such that <code>t[n + 1]</code> is <code>nil</code>.
Given the arrays, returns an array containing the elements of each input array in sequence.
It is similar to the operator <code>#</code>, but may return a different value when there are gaps in the array portion of the table.
Intended to be used on data loaded with <code>[[mw:Special:MyLanguage/Extension:Scribunto/Lua reference manual#mw.loadData|mw.loadData]]</code> and on <code>[[mw:Special:MyLanguage/Extension:Scribunto/Lua reference manual#frame.args|frame.args]]</code>.
Both use a metatable such that <code>#mw.loadData("module:...")</code> and <code>#frame.args</code> don't work correctly.
For other tables, use <code>#</code>.


=== inArray ===
== extend ==


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


Returns <syntaxhighlight lang="lua" inline>true</syntaxhighlight> if <code>valueToFind</code> is a member of the array <code>arr</code>, and <syntaxhighlight lang="lua" inline>false</syntaxhighlight> otherwise.
Extends the first array in place by appending all elements from the second array.
 
== See also ==
* {{ml|params|}}
 
<includeonly>{{Sandbox other||
<includeonly>{{Sandbox other||
[[Category:Modules]]
[[Category:Lua metamodules|TableTools]]
[[Category:Lua metamodules|TableTools]]
}}</includeonly>
}}</includeonly>
<noinclude>
[[Category:Module documents]]
</noinclude>

Latest revision as of 01:11, 10 March 2025

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. If you want to make a new table with no shared subtables and without metatables transferred, use deepCopy with the noMetatable option.

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 {5, 4, 4, 3, 4, 2, 2, 1} removeDuplicates will return {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 {'foo', nil, 'bar', 'baz', a = 'b'}, numKeys will return {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 {a1 = 'foo', a3 = 'bar', a6 = 'baz'} and the prefix 'a', affixNums will return {1, 3, 6}. All characters in 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 { [1] = {foo = 'text', bar = 'text'}, [2] = {foo = 'text', baz = 'text'} }. 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

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 {1, nil, foo = 'bar', 3, 2}, compressSparseArray will return {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 (associative array). For example, for {foo = 'foo', bar = 'bar'}, size will return 2. The function will also work on arrays, but for arrays it is more efficient to use the # operator. Note that to find the size, this function uses the pairs function to iterate through all of the keys.

keysToList

TableTools.keysToList(t, keySort, checked)

Returns a list of the keys in a table, sorted using either a default comparison function or a custom keySort function, which follows the same rules as the comp function supplied to table.sort. If keySort is false, no sorting is done. Set checked to true to skip the internal type checking.

sortedPairs

TableTools.sortedPairs(t, keySort)

Iterates through a table, with the keys sorted using the keysToList function. If there are only numerical keys, sparseIpairs is probably more efficient.

isArray

TableTools.isArray(value)

Returns true if value is a table and all keys are consecutive integers starting at 1.

isArrayLike

TableTools.isArrayLike(value)

Returns true if value is iterable and all keys are consecutive integers starting at 1.

invert

TableTools.invert(arr)

Transposes the keys and values in an array. For example, invert{ "a", "b", "c" } yields { a=1, b=2, c=3 }.

listToSet

TableTools.listToSet(arr)

Creates a set from the array part of the table arr. Indexing the set by any of the values of the array returns true. For example, listToSet{ "a", "b", "c" } yields { a=true, b=true, c=true }.

deepCopy

TableTools.deepCopy(orig, noMetatable, alreadySeen)

Creates a copy of the table orig. As with mw.clone, all values that are not functions are duplicated and the identity of tables is preserved. If noMetatable is true, then the metatable (if any) is not copied. Can copy tables loaded with mw.loadData.

Similar to mw.clone, but mw.clone cannot copy tables loaded with mw.loadData and does not allow metatables not to be copied.

sparseConcat

TableTools.sparseConcat(t, sep, i, j)

Concatenates all values in the table that are indexed by a positive integer, in order. For example, sparseConcat{ "a", nil, "c", "d" } yields "acd" and sparseConcat{ nil, "b", "c", "d" } yields "bcd".

length

TableTools.length(t, prefix)

Finds the length of an array or of a quasi-array with keys with an optional prefix such as "data1", "data2", etc. It uses an exponential search algorithm to find the length, so as to use as few table lookups as possible.

This algorithm is useful for arrays that use metatables (e.g. frame.args) and for quasi-arrays. For normal arrays, just use the # operator, as it is implemented in C and will be quicker.

inArray

TableTools.inArray(array, searchElement)
TableTools.inArray(array, searchElement, fromIndex)

Returns true if searchElement is a member of the array array, and false otherwise. Equivalent to the javascript Array.prototype.includes() function, except fromIndex is 1-indexed instead of zero-indexed.

fromIndex

fromIndex is the optional 1-based index at which to start searching. If fromIndex is not present, all values in the array will be searched and the array will be treated as a table/associative array (it will be iterated over using pairs()).

If fromIndex is present and an integer, the array is assumed to be a conventional array/sequence/list (indexed with consecutive integer keys starting at 1, and interated over using ipairs()). Only the values whose index is fromIndex or higher will be searched.

In the following examples, #array represents the length of the integer-keyed portion of the array.

  • If fromIndex < 0 it will count back from the end of the array, e.g. a value of -1 will only search the last integer-keyed element in the array. If fromIndex <= (-1 * #array), the entire integer-keyed portion of the array will be searched.
  • If fromIndex = 0 it will be treated as a 1 and the entire integer-keyed portion of the array will be searched.
  • If fromIndex > #array, the array is not searched and false is returned.

merge

TableTools.merge(...)

Given the arrays, returns an array containing the elements of each input array in sequence.

extend

TableTools.extend(arr1, arr2)

Extends the first array in place by appending all elements from the second array.

See also

Retrieved from "https://kenshi.wiki/index.php?title=Module:TableTools/doc&oldid=15829"