Module:TableTools/doc: Difference between revisions

From The Unofficial Isekai:Slow Life Wiki
Jump to navigation Jump to search
VisualWikitext
(Created page with "{{used in system}} {{module rating|p}} {{cascade-protected template|page=module}} {{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. == Loading the module == To use any of the functions, first you must load the module. <syntaxhighlight lang="lua"> local TableTools = require('Module:TableToo...")
 
mNo edit summary
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{used in system}}
{{Documentation subpage|cat=Module documentation subpages}}
{{module rating|p}}
{{cascade-protected template|page=module}}
{{lua|Module:Exponential search|noprotcat=yes}}
{{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.
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.
Line 15: Line 13:
== isPositiveInteger ==
== isPositiveInteger ==


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


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.
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.
Line 23: Line 21:
== isNan ==
== isNan ==


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


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.)
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.)
Line 31: Line 29:
== shallowClone ==
== shallowClone ==


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


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.
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.
Line 39: Line 37:
== removeDuplicates ==
== removeDuplicates ==


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


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}}.
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}}.
Line 47: Line 45:
== numKeys ==
== numKeys ==


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


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}}.
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}}.
Line 55: Line 53:
== affixNums ==
== affixNums ==


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


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.
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.
Line 65: Line 63:
== numData ==
== numData ==


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


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>.
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>.
Line 73: Line 71:
== compressSparseArray ==
== compressSparseArray ==


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


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}}.
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}}.
Line 83: Line 81:
== sparseIpairs ==
== sparseIpairs ==


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


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.
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.
Line 101: Line 99:
== size ==
== size ==


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


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.
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.
Line 117: Line 115:
== sortedPairs ==
== sortedPairs ==


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


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.
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.
Line 125: Line 123:
== isArray ==
== isArray ==


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


Returns <code>true</code> if <code>''value''</code> is a table and all keys are consecutive integers starting at 1.
Returns <code>true</code> if <code>''value''</code> is a table and all keys are consecutive integers starting at 1.
Line 133: Line 131:
== isArrayLike ==
== isArrayLike ==


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


Returns <code>true</code> if <code>''value''</code> is iterable and all keys are consecutive integers starting at 1.
Returns <code>true</code> if <code>''value''</code> is iterable and all keys are consecutive integers starting at 1.
Line 141: Line 139:
== invert ==
== invert ==


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


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}}.
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}}.
Line 149: Line 147:
== listToSet ==
== listToSet ==


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


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}}.
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}}.
Line 157: Line 155:
== deepCopy ==
== deepCopy ==


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


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>.
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>.
Line 167: Line 165:
== sparseConcat ==
== sparseConcat ==


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


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}}.
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}}.
Line 175: Line 173:
== length ==
== length ==


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


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.
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.
Line 185: Line 183:
== inArray ==
== inArray ==


<syntaxhighlight lang="lua">TableTools.inArray(array, searchElement)
<pre>TableTools.inArray(array, searchElement)
TableTools.inArray(array, searchElement, fromIndex)</syntaxhighlight>
TableTools.inArray(array, searchElement, fromIndex)</pre>


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.
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.
Line 203: Line 201:
== merge ==
== merge ==


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


Given the arrays, returns an array containing the elements of each input array in sequence.
Given the arrays, returns an array containing the elements of each input array in sequence.
Line 211: Line 209:
== extend ==
== extend ==


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


Extends the first array in place by appending all elements from the second array.
Extends the first array in place by appending all elements from the second array.
Line 221: Line 219:


<includeonly>{{Sandbox other||
<includeonly>{{Sandbox other||
<!-- MODULE CATEGORY -->
[[Category:Lua metamodules|TableTools]]
[[Category:Lua metamodules|TableTools]]
}}</includeonly>
}}</includeonly>
<noinclude>
<!-- MODULE DOCUMENTATION CATEGORIES -->
[[Category:Module documentation subpages imported from Wikipedia]]
</noinclude>

Latest revision as of 19:08, 31 July 2025

This is the /doc subpage of Module:TableTools. Any changes made here will reflect on the main template page.

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.

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

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 <syntaxhighlight lang="lua" class="" style="" inline="1">{5, 4, 4, 3, 4, 2, 2, 1}</syntaxhighlight> removeDuplicates will return <syntaxhighlight lang="lua" class="" style="" inline="1">{5, 4, 3, 2, 1}</syntaxhighlight>.

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 <syntaxhighlight lang="lua" class="" style="" inline="1">{'foo', nil, 'bar', 'baz', a = 'b'}</syntaxhighlight>, numKeys will return <syntaxhighlight lang="lua" class="" style="" inline="1">{1, 3, 4}</syntaxhighlight>.

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

See Template:Mfl and Template:Mfl for doing something similar from a wiki template.

numData

TableTools.numData(t, compress)
</pre

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

== compressSparseArray ==

<pre>
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 <syntaxhighlight lang="lua" class="" style="" inline="1">{1, nil, foo = 'bar', 3, 2}</syntaxhighlight>, compressSparseArray will return <syntaxhighlight lang="lua" class="" style="" inline="1">{1, 3, 2}</syntaxhighlight>.

See Template:Mfl for doing something similar from a wiki template.

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.

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

  -- code block

end </syntaxhighlight>

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 <syntaxhighlight lang="lua" class="" style="" inline="1">{foo = 'foo', bar = 'bar'}</syntaxhighlight>, 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

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

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, <syntaxhighlight lang="lua" class="" style="" inline="1">invert{ "a", "b", "c" }</syntaxhighlight> yields <syntaxhighlight lang="lua" class="" style="" inline="1">{ a=1, b=2, c=3 }</syntaxhighlight>.

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, <syntaxhighlight lang="lua" class="" style="" inline="1">listToSet{ "a", "b", "c" }</syntaxhighlight> yields <syntaxhighlight lang="lua" class="" style="" inline="1">{ a=true, b=true, c=true }</syntaxhighlight>.

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, <syntaxhighlight lang="lua" class="" style="" inline="1">sparseConcat{ "a", nil, "c", "d" }</syntaxhighlight> yields <syntaxhighlight lang="lua" class="" style="" inline="1">"acd"</syntaxhighlight> and <syntaxhighlight lang="lua" class="" style="" inline="1">sparseConcat{ nil, "b", "c", "d" }</syntaxhighlight> yields <syntaxhighlight lang="lua" class="" style="" inline="1">"bcd"</syntaxhighlight>.

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 <syntaxhighlight lang="lua" inline>pairs()</syntaxhighlight>).

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 <syntaxhighlight lang="lua" inline>ipairs()</syntaxhighlight>). 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://isekai.wiki/index.php?title=Module:TableTools/doc&oldid=6502"