Difference between revisions of "Module:TableTools/doc"
m (1 revision) |
en>Mr. Stradivarius (→length: exponential search, not binary search (though they are similar)) |
||
| Line 1: | Line 1: | ||
| − | {{high- | + | {{high-use|3,780,000|all-pages = yes}} |
| − | {{module rating| | + | {{module rating|protected}} |
| + | {{used in system}} | ||
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 8: | Line 9: | ||
To use any of the functions, first you must load the module. | To use any of the functions, first you must load the module. | ||
| − | < | + | <syntaxhighlight lang="lua"> |
local TableTools = require('Module:TableTools') | local TableTools = require('Module:TableTools') | ||
| − | </ | + | </syntaxhighlight> |
== isPositiveInteger == | == isPositiveInteger == | ||
| − | < | + | <syntaxhighlight lang="lua"> |
TableTools.isPositiveInteger(value) | TableTools.isPositiveInteger(value) | ||
| − | </ | + | </syntaxhighlight> |
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 22: | Line 23: | ||
== isNan == | == isNan == | ||
| − | < | + | <syntaxhighlight lang="lua"> |
TableTools.isNan(value) | TableTools.isNan(value) | ||
| − | </ | + | </syntaxhighlight> |
| − | 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.) |
== shallowClone == | == shallowClone == | ||
| − | < | + | <syntaxhighlight lang="lua"> |
TableTools.shallowClone(t) | TableTools.shallowClone(t) | ||
| − | </ | + | </syntaxhighlight> |
| − | 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:Extension:Scribunto/Lua reference manual#mw.clone|mw.clone]] instead. | + | 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. |
== removeDuplicates == | == removeDuplicates == | ||
| − | < | + | <syntaxhighlight lang="lua"> |
TableTools.removeDuplicates(t) | TableTools.removeDuplicates(t) | ||
| − | </ | + | </syntaxhighlight> |
| − | 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 [[#compressSparseArray|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 {{code|code={5, 4, 4, 3, 4, 2, 2, 1}|lang=lua}} removeDuplicates 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}} |
== numKeys == | == numKeys == | ||
| − | < | + | <syntaxhighlight lang="lua"> |
TableTools.numKeys(t) | TableTools.numKeys(t) | ||
| − | </ | + | </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. For example, for the table {{code|code={'foo', nil, 'bar', 'baz', a = 'b'}|lang=lua}}, numKeys 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}}. |
== affixNums == | == affixNums == | ||
| − | < | + | <syntaxhighlight lang="lua"> |
TableTools.affixNums(t, prefix, suffix) | TableTools.affixNums(t, prefix, suffix) | ||
| − | </ | + | </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>. For example, for the table {{code|code={a1 = 'foo', a3 = 'bar', a6 = 'baz'}|lang=lua}} and the prefix <code>'a'</code>, affixNums 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. |
== numData == | == numData == | ||
| − | < | + | <syntaxhighlight lang="lua"> |
TableTools.numData(t, compress) | TableTools.numData(t, compress) | ||
| − | </ | + | </syntaxhighlight> |
| − | Given a table with keys like "foo1", "bar1", "foo2", and "baz2", 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 "other". The compress option compresses the table so that it can be iterated over with ipairs. | + | 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 == | == compressSparseArray == | ||
| − | < | + | <syntaxhighlight lang="lua"> |
TableTools.compressSparseArray(t) | TableTools.compressSparseArray(t) | ||
| − | </ | + | </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 ipairs. Any keys that are not positive integers are removed. For example, for the table {{code|code={1, nil, foo = 'bar', 3, 2}|lang=lua}}, compressSparseArray 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}}. |
== sparseIpairs == | == sparseIpairs == | ||
| − | < | + | <syntaxhighlight lang="lua"> |
TableTools.sparseIpairs(t) | TableTools.sparseIpairs(t) | ||
| − | </ | + | </syntaxhighlight> |
| − | This is an iterator function for traversing a sparse array <code>''t''</code>. It is similar to [[mw:Extension:Scribunto/Lua reference manual#ipairs|ipairs]], but will continue to iterate until the highest numerical key, whereas ipairs 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. |
| − | Usually sparseIpairs is used in a generic <code>for</code> loop. | + | Usually <code>sparseIpairs</code> is used in a generic <code>for</code> loop. |
| − | < | + | <syntaxhighlight lang="lua"> |
for i, v in TableTools.sparseIpairs(t) do | for i, v in TableTools.sparseIpairs(t) do | ||
-- code block | -- code block | ||
end | end | ||
| − | </ | + | </syntaxhighlight> |
| − | Note that sparseIpairs uses the [[mw:Extension:Scribunto/Lua reference manual#pairs|pairs]] function in its implementation. Although some table keys appear to be ignored, all table keys are accessed when it is run. | + | 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. |
== size == | == size == | ||
| − | < | + | <syntaxhighlight lang="lua"> |
TableTools.size(t) | TableTools.size(t) | ||
| − | </ | + | </syntaxhighlight> |
| − | Finds the size of a key/value pair table. For example, for the table {{code|code={foo = 'foo', bar = 'bar'}|lang=lua}}, size will return <code>2</code>. The function will also work on arrays, but for arrays it is more efficient to use the # operator. Note that to find the table size, this function uses the [[mw:Extension:Scribunto/Lua reference manual#pairs|pairs]] function to iterate through all of the table keys.< | + | Finds the size of a key/value pair table. For example, for the table {{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 table size, this function uses the <code>[[mw:Extension:Scribunto/Lua reference manual#pairs|pairs]]</code> function to iterate through all of the table keys. |
| − | [[Category:Lua metamodules|TableTools | + | |
| + | == keysToList == | ||
| + | |||
| + | <syntaxhighlight lang="lua"> | ||
| + | TableTools.keysToList(t, keySort) | ||
| + | </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 [[mw:Extension:Scribunto/Lua reference manual#table.sort|<code>table.sort</code>]]. | ||
| + | |||
| + | == sortedPairs == | ||
| + | |||
| + | <syntaxhighlight lang="lua"> | ||
| + | TableTools.sortedPairs(t, keySort) | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | 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. | ||
| + | |||
| + | == isArray == | ||
| + | |||
| + | <syntaxhighlight lang="lua"> | ||
| + | TableTools.isArray(t) | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | Returns true if all keys in the table are consecutive integers starting at <code>1</code>. | ||
| + | |||
| + | == listToSet == | ||
| + | |||
| + | <syntaxhighlight lang="lua"> | ||
| + | TableTools.listToSet(arr) | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | Creates a set from the array part of the table <code>arr</code>. Indexing the set by any of the values in <code>arr</code> returns <code>true</code>. | ||
| + | |||
| + | <syntaxhighlight lang="lua"> | ||
| + | local set = TableTools.listToSet { "a", "b", "c" } | ||
| + | assert(set["a"] == true) | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | == invert == | ||
| + | |||
| + | <syntaxhighlight lang="lua"> | ||
| + | TableTools.invert(t) | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | Transposes the keys and values in an array. For example, <code>invert{ "a", "b", "c" }</code> yields <code>{ a = 1, b = 2, c = 3 }</code>. | ||
| + | |||
| + | == deepCopy == | ||
| + | |||
| + | <syntaxhighlight lang="lua"> | ||
| + | TableTools.deepCopy(orig, noMetatable, alreadySeen) | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | 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>. | ||
| + | |||
| + | 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 == | ||
| + | |||
| + | <syntaxhighlight lang="lua"> | ||
| + | TableTools.sparseConcat(t, sep) | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | Concatenates all values in the table that are indexed by a positive integer, in order. | ||
| + | |||
| + | == length == | ||
| + | |||
| + | <syntaxhighlight lang="lua"> | ||
| + | TableTools.length(t) | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | Finds the length of an array, or of a quasi-array with keys such as "data1", "data2", etc. It uses a [[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(arr, valueToFind) | ||
| + | </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. | ||
| + | |||
| + | <includeonly>{{Sandbox other|| | ||
| + | [[Category:Lua metamodules|TableTools]] | ||
}}</includeonly> | }}</includeonly> | ||
Revision as of 15:22, 12 October 2020
 | This Lua module is used on approximately 4,580,000 pages, or roughly 8856% of all pages. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. Transclusion count updated automatically (see documentation). |
 | This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
 | This module is used in system messages. Changes to it can cause immediate changes to the Wikipedia user interface. To avoid large-scale disruption, any changes should first be tested in this module's /sandbox or /testcases subpage, or in your own user space. The tested changes can then be added in one single edit to this module. Please discuss any changes on the talk page before implementing them. |
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.
Contents
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
<syntaxhighlight lang="lua"> TableTools.isPositiveInteger(value) </syntaxhighlight>
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
<syntaxhighlight lang="lua"> TableTools.isNan(value) </syntaxhighlight>
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
<syntaxhighlight lang="lua"> TableTools.shallowClone(t) </syntaxhighlight>
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
<syntaxhighlight lang="lua"> TableTools.removeDuplicates(t) </syntaxhighlight>
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="" id="" style="" inline="1">{5, 4, 4, 3, 4, 2, 2, 1}</syntaxhighlight> removeDuplicates will return <syntaxhighlight lang="lua" class="" id="" style="" inline="1">{5, 4, 3, 2, 1}</syntaxhighlight>
numKeys
<syntaxhighlight lang="lua"> TableTools.numKeys(t) </syntaxhighlight>
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="" id="" style="" inline="1">{'foo', nil, 'bar', 'baz', a = 'b'}</syntaxhighlight>, numKeys will return <syntaxhighlight lang="lua" class="" id="" style="" inline="1">{1, 3, 4}</syntaxhighlight>.
affixNums
<syntaxhighlight lang="lua"> TableTools.affixNums(t, prefix, suffix) </syntaxhighlight>
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="" id="" style="" inline="1">{a1 = 'foo', a3 = 'bar', a6 = 'baz'}</syntaxhighlight> and the prefix 'a', affixNums will return <syntaxhighlight lang="lua" class="" id="" style="" inline="1">{1, 3, 6}</syntaxhighlight>. All characters in prefix and suffix are interpreted literally.
numData
<syntaxhighlight lang="lua"> TableTools.numData(t, compress) </syntaxhighlight>
Given a table with keys like "foo1", "bar1", "foo2", and "baz2", returns a table of subtables in the format <syntaxhighlight lang="lua" class="" id="" style="" inline="1">{ [1] = {foo = 'text', bar = 'text'}, [2] = {foo = 'text', baz = 'text'} }</syntaxhighlight>. 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
<syntaxhighlight lang="lua"> TableTools.compressSparseArray(t) </syntaxhighlight>
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="" id="" style="" inline="1">{1, nil, foo = 'bar', 3, 2}</syntaxhighlight>, compressSparseArray will return <syntaxhighlight lang="lua" class="" id="" style="" inline="1">{1, 3, 2}</syntaxhighlight>.
sparseIpairs
<syntaxhighlight lang="lua"> TableTools.sparseIpairs(t) </syntaxhighlight>
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
<syntaxhighlight lang="lua"> TableTools.size(t) </syntaxhighlight>
Finds the size of a key/value pair table. For example, for the table <syntaxhighlight lang="lua" class="" id="" 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 table size, this function uses the pairs function to iterate through all of the table keys.
keysToList
<syntaxhighlight lang="lua"> TableTools.keysToList(t, keySort) </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.
sortedPairs
<syntaxhighlight lang="lua"> TableTools.sortedPairs(t, keySort) </syntaxhighlight>
Iterates through a table, with the keys sorted using the keysToList function. If there are only numerical keys, sparseIpairs is probably more efficient.
isArray
<syntaxhighlight lang="lua"> TableTools.isArray(t) </syntaxhighlight>
Returns true if all keys in the table are consecutive integers starting at 1.
listToSet
<syntaxhighlight lang="lua"> TableTools.listToSet(arr) </syntaxhighlight>
Creates a set from the array part of the table arr. Indexing the set by any of the values in arr returns true.
<syntaxhighlight lang="lua"> local set = TableTools.listToSet { "a", "b", "c" } assert(set["a"] == true) </syntaxhighlight>
invert
<syntaxhighlight lang="lua"> TableTools.invert(t) </syntaxhighlight>
Transposes the keys and values in an array. For example, invert{ "a", "b", "c" } yields { a = 1, b = 2, c = 3 }.
deepCopy
<syntaxhighlight lang="lua"> TableTools.deepCopy(orig, noMetatable, alreadySeen) </syntaxhighlight>
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
<syntaxhighlight lang="lua"> TableTools.sparseConcat(t, sep) </syntaxhighlight>
Concatenates all values in the table that are indexed by a positive integer, in order.
length
<syntaxhighlight lang="lua"> TableTools.length(t) </syntaxhighlight>
Finds the length of an array, or of a quasi-array with keys such as "data1", "data2", etc. It uses a 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
<syntaxhighlight lang="lua"> TableTools.inArray(arr, valueToFind) </syntaxhighlight>
Returns <syntaxhighlight lang="lua" inline>true</syntaxhighlight> if valueToFind is a member of the array arr, and <syntaxhighlight lang="lua" inline>false</syntaxhighlight> otherwise.
