Модуль:TableTools/doc: различия между версиями
Andras (обсуждение | вклад) Нет описания правки |
Andras (обсуждение | вклад) Нет описания правки |
||
| Строка 1: | Строка 1: | ||
{{ | {{Docpage}} | ||
{{ | {{Module rating|protected}} | ||
Данный модуль предоставляет функции для работы с [[Lua#Таблицы|таблицами Lua]]. В общем случае, его функции не должны вызываться напрямую через #invoke, а только использоваться в других модулях. | Данный модуль предоставляет функции для работы с [[Lua#Таблицы|таблицами Lua]]. В общем случае, его функции не должны вызываться напрямую через #invoke, а только использоваться в других модулях. | ||
| Строка 13: | Строка 13: | ||
TableTools.isPositiveInteger(value) | TableTools.isPositiveInteger(value) | ||
}} | }} | ||
Возвращает {{LuaTrue}} если {{ | Возвращает {{LuaTrue}} если {{Codevar|value}} — положительное целое число и {{LuaFalse}} иначе. Хотя эта функция и не относится напрямую к таблицам, она нужна для определения, является ли ключ ключом массива либо же хэш-таблицы. | ||
== isNan == | == isNan == | ||
| Строка 19: | Строка 19: | ||
TableTools.isNan(value) | TableTools.isNan(value) | ||
}} | }} | ||
Возвращает {{LuaTrue}} если {{ | Возвращает {{LuaTrue}} если {{Codevar|value}} представляет собой [[NaN]] и {{LuaFalse}} иначе. Хотя эта функция и не относится напрямую к таблицам, она нужна для определения, может ли значение быть ключом таблицы. | ||
== shallowClone == | == shallowClone == | ||
| Строка 25: | Строка 25: | ||
TableTools.shallowClone(t) | TableTools.shallowClone(t) | ||
}} | }} | ||
Возвращает клон таблицы. Возвращаемое значение представляет собой новую таблицу, но все подтаблицы и функции являются разделяемыми. Метаметоды переносятся, но возвращаемая таблица не будет включать [[Lua#Метатаблицы|метатаблицу]]. Если вы хотите скопировать подтаблицы и метатаблицу, используйте {{ | Возвращает клон таблицы. Возвращаемое значение представляет собой новую таблицу, но все подтаблицы и функции являются разделяемыми. Метаметоды переносятся, но возвращаемая таблица не будет включать [[Lua#Метатаблицы|метатаблицу]]. Если вы хотите скопировать подтаблицы и метатаблицу, используйте {{Scribunto reference|mw.clone}}. Если вы хотите скопировать подтаблицы, но не переносить метатаблицы, используйте {{Code|[[#deepCopy|deepCopy]]}} с параметром {{Code|noMetatable}}. | ||
== removeDuplicates == | == removeDuplicates == | ||
| Строка 37: | Строка 37: | ||
TableTools.numKeys(t) | TableTools.numKeys(t) | ||
}} | }} | ||
Принимает на вход таблицу {{ | Принимает на вход таблицу {{Codevar|t}} и возвращает массив из положительных целых чисел, которые являются ключами таблицы для данных с непустым значением, отсортированный в порядке возрастания. Например, для таблицы {{LuaCode|1={'foo', nil, 'bar', 'baz', a = 'b'}|inline=1}} вызов {{Code|numKeys}} вернёт {{LuaCode|{1, 3, 4}|inline=1}}. | ||
== affixNums == | == affixNums == | ||
| Строка 43: | Строка 43: | ||
TableTools.affixNums(t, prefix, suffix) | TableTools.affixNums(t, prefix, suffix) | ||
}} | }} | ||
Принимает на вход таблицу {{ | Принимает на вход таблицу {{Codevar|t}} и возвращает массив из положительных целых чисел, которым соответствуют ключи таблицы с опциональным префиксом {{Codevar|prefix}} и опциональным суффиксом {{Codevar|suffix}}. Например, для таблицы {{LuaCode|1={a1 = 'foo', a3 = 'bar', a6 = 'baz'}|inline=1}} и префикса {{Codevar|a}} вызов {{Code|affixNums}} вернёт {{LuaCode|{1, 3, 6}|inline=1}}. Все символы в {{Codevar|prefix}} и {{Codevar|suffix}} интерпретируются буквально. | ||
== numData == | == numData == | ||
| Строка 49: | Строка 49: | ||
TableTools.numData(t, compress) | TableTools.numData(t, compress) | ||
}} | }} | ||
Дла таблицы с ключами вида {{ | Дла таблицы с ключами вида {{Codevar|foo1}}, {{Codevar|bar1}}, {{Codevar|foo2}} и {{Codevar|baz2}} возвращает таблицы с подтаблицами в формате {{LuaCode|1={ [1] = {foo = 'text', bar = 'text'}, [2] = {foo = 'text', baz = 'text'} }|inline=1}}. Ключи, не заканчивающиеся числом размещаются в подтаблице {{Codevar|other}}. Опция {{Codevar|compress}} позволяет использовать таблицу для цикла с помощью {{Code|ipairs}}. | ||
== compressSparseArray == | == compressSparseArray == | ||
| Строка 55: | Строка 55: | ||
TableTools.compressSparseArray(t) | TableTools.compressSparseArray(t) | ||
}} | }} | ||
Принимает на вход массив {{ | Принимает на вход массив {{Codevar|t}} с пустыми значениями ({{LuaCode|nil|inline=1}}) и убирает их, сохраняя порядок, чтобы массив мог использоваться в {{Code|ipairs}}. Нечисловые ключи удаляются. Например, для таблицы {{LuaCode|1={1, nil, foo = 'bar', 3, 2}|inline=1}} вызов {{Code|compressSparseArray}} вернёт {{LuaCode|{1, 3, 2}|inline=1}}. | ||
== sparseIpairs == | == sparseIpairs == | ||
| Строка 61: | Строка 61: | ||
TableTools.sparseIpairs(t) | TableTools.sparseIpairs(t) | ||
}} | }} | ||
Итератор для перебора элементов разреженного массива {{ | Итератор для перебора элементов разреженного массива {{Codevar|t}}. Аналогичен {{Scribunto reference|ipairs}}, но продолжится до достижения ключа с максимальным числовым значением, в отличе от обычного {{Code|ipairs}}, останавливающегося на первом {{LuaCode|nil|inline=1}}. Нечисловые ключи игнорируются. | ||
{{Code|sparseIpairs}} может использоваться для цикла {{Code|for}}. | {{Code|sparseIpairs}} может использоваться для цикла {{Code|for}}. | ||
| Строка 71: | Строка 71: | ||
}} | }} | ||
Обратите внимание, что функция {{Code|sparseIpairs}} основана на {{ | Обратите внимание, что функция {{Code|sparseIpairs}} основана на {{Scribunto reference|pairs}}. Хота в итератор для цикла могут передаваться не все ключи, читаться будут всё равно все. | ||
== size == | == size == | ||
| Строка 77: | Строка 77: | ||
TableTools.size(t) | TableTools.size(t) | ||
}} | }} | ||
Возращает размер таблицы пар ключ-значение. Например, для таблицы {{LuaCode|1={foo = 'foo', bar = 'bar'}|inline=1}} вызов {{Code|size}} вернёт {{Code|2}}. Функция также работает и для массивов, но для них следует использовать встроенный оператор языка {{Code|#}}. Обратите внимание, что в своей работе функция использует функцию {{ | Возращает размер таблицы пар ключ-значение. Например, для таблицы {{LuaCode|1={foo = 'foo', bar = 'bar'}|inline=1}} вызов {{Code|size}} вернёт {{Code|2}}. Функция также работает и для массивов, но для них следует использовать встроенный оператор языка {{Code|#}}. Обратите внимание, что в своей работе функция использует функцию {{Scribunto reference|pairs}} для итерирования по всем ключам. | ||
== keysToList == | == keysToList == | ||
| Строка 83: | Строка 83: | ||
TableTools.keysToList(t, keySort) | TableTools.keysToList(t, keySort) | ||
}} | }} | ||
Возвращает список ключей таблицы, используя либо сортировку по умолчанию, либо произвольную функцию {{ | Возвращает список ключей таблицы, используя либо сортировку по умолчанию, либо произвольную функцию {{Codevar|keySort}}, соотвествующую правилам для функции {{Code|comp}} для {{scribunto reference|table.sort}}. | ||
== sortedPairs == | == sortedPairs == | ||
| Строка 101: | Строка 101: | ||
TableTools.listToSet(arr) | TableTools.listToSet(arr) | ||
}} | }} | ||
Создаёт множество на основе значений числовых ключей таблицы {{ | Создаёт множество на основе значений числовых ключей таблицы {{Codevar|arr}}. Получение значения множества для значений {{Codevar|arr}} вернёт {{LuaTrue}}. | ||
{{LuaCode|1= | {{LuaCode|1= | ||
local set = TableTools.listToSet { "a", "b", "c" } | local set = TableTools.listToSet { "a", "b", "c" } | ||
| Строка 117: | Строка 117: | ||
TableTools.deepCopy(orig, noMetatable, alreadySeen) | TableTools.deepCopy(orig, noMetatable, alreadySeen) | ||
}} | }} | ||
Создаёт копию таблицы {{ | Создаёт копию таблицы {{Codevar|orig}}. Как и при использовании {{Code|mw.clone}} все значения, не являющиеся функциями, дублируются и идентичность таблиц сохраняется. Если {{Codevar|noMetatable}} выставляется в {{LuaTrue}}, метатаблица (если имеется) не копируется. Может копировать таблицы, загруженные с помощью {{Code|mw.loadData}}. | ||
В отличие от этой функции {{Code|mw.clone}} не работает с таблицами, загруженными с помощью {{Code|mw.loadData}}, и не имеет возможности <em>не</em> копировать метатаблицы. | В отличие от этой функции {{Code|mw.clone}} не работает с таблицами, загруженными с помощью {{Code|mw.loadData}}, и не имеет возможности <em>не</em> копировать метатаблицы. | ||
| Строка 133: | Строка 133: | ||
Возвращает длину массива или псевдомассива с ключами вида {{Code|data1}}, {{Code|data2}} и т.д. Использует алгоритм [[:en:exponential search|экспоненциального поиска]], поэтому производится минимальное количество обращений. | Возвращает длину массива или псевдомассива с ключами вида {{Code|data1}}, {{Code|data2}} и т.д. Использует алгоритм [[:en:exponential search|экспоненциального поиска]], поэтому производится минимальное количество обращений. | ||
Алгоритм полезен для массивов с метатаблицами (например, {{ | Алгоритм полезен для массивов с метатаблицами (например, {{Scribunto reference|frame.args}}) и для псевдомассивов. Для обычных массивов предпочтительнее оператор {{Scribunto reference|Length operator|#}}, реализованный на [[Си]], он будет работать заметно быстрее. | ||
== inArray == | == inArray == | ||
| Строка 139: | Строка 139: | ||
TableTools.inArray(arr, valueToFind) | TableTools.inArray(arr, valueToFind) | ||
}} | }} | ||
Возвращает {{LuaTrue}} если {{ | Возвращает {{LuaTrue}} если {{Codevar|valueToFind}} входит в {{Codevar|arr}} или {{LuaFalse}} иначе. | ||
<includeonly> | <includeonly> | ||
[[Категория:Модули:Базовые]] | [[Категория:Модули:Базовые]] | ||
</includeonly> | </includeonly> | ||
Версия от 15:43, 9 мая 2023
 |
Шаблон:Module rating Данный модуль предоставляет функции для работы с таблицами Lua. В общем случае, его функции не должны вызываться напрямую через #invoke, а только использоваться в других модулях.
Подключение
Для использования функционала модуль сперва следует подключить.
local TableTools = require('Module:TableTools')isPositiveInteger
TableTools.isPositiveInteger(value)Возвращает true если value — положительное целое число и false иначе. Хотя эта функция и не относится напрямую к таблицам, она нужна для определения, является ли ключ ключом массива либо же хэш-таблицы.
isNan
TableTools.isNan(value)Возвращает true если value представляет собой NaN и false иначе. Хотя эта функция и не относится напрямую к таблицам, она нужна для определения, может ли значение быть ключом таблицы.
shallowClone
TableTools.shallowClone(t)Возвращает клон таблицы. Возвращаемое значение представляет собой новую таблицу, но все подтаблицы и функции являются разделяемыми. Метаметоды переносятся, но возвращаемая таблица не будет включать метатаблицу. Если вы хотите скопировать подтаблицы и метатаблицу, используйте Шаблон:Scribunto reference. Если вы хотите скопировать подтаблицы, но не переносить метатаблицы, используйте [[#deepCopy|deepCopy]] с параметром noMetatable.
removeDuplicates
TableTools.removeDuplicates(t)Удаляет из массива значения-дубликаты. Функция предназначена для работы только со стандартными массивами: обрабатываются только ключи-положительные целые числа, а все значения после первого nil игнорируются. (Для массивов, содержащих nil, используйте [[#compressSparseArray|compressSparseArray]] перед этой функцией.) Функция старается сохранить порядок следования элементов — оставляется первое вхождение значения, а все последующие удаляются. Например, для таблицы {5, 4, 4, 3, 4, 2, 2, 1} removeDuplicates вернёт {5, 4, 3, 2, 1}.
numKeys
TableTools.numKeys(t)Принимает на вход таблицу t и возвращает массив из положительных целых чисел, которые являются ключами таблицы для данных с непустым значением, отсортированный в порядке возрастания. Например, для таблицы {'foo', nil, 'bar', 'baz', a = 'b'} вызов numKeys вернёт {1, 3, 4}.
affixNums
TableTools.affixNums(t, prefix, suffix)Принимает на вход таблицу t и возвращает массив из положительных целых чисел, которым соответствуют ключи таблицы с опциональным префиксом prefix и опциональным суффиксом suffix. Например, для таблицы {a1 = 'foo', a3 = 'bar', a6 = 'baz'} и префикса a вызов affixNums вернёт {1, 3, 6}. Все символы в prefix и suffix интерпретируются буквально.
numData
TableTools.numData(t, compress)Дла таблицы с ключами вида foo1, bar1, foo2 и baz2 возвращает таблицы с подтаблицами в формате { [1] = {foo = 'text', bar = 'text'}, [2] = {foo = 'text', baz = 'text'} }. Ключи, не заканчивающиеся числом размещаются в подтаблице other. Опция compress позволяет использовать таблицу для цикла с помощью ipairs.
compressSparseArray
TableTools.compressSparseArray(t)Принимает на вход массив t с пустыми значениями (nil) и убирает их, сохраняя порядок, чтобы массив мог использоваться в ipairs. Нечисловые ключи удаляются. Например, для таблицы {1, nil, foo = 'bar', 3, 2} вызов compressSparseArray вернёт {1, 3, 2}.
sparseIpairs
TableTools.sparseIpairs(t)Итератор для перебора элементов разреженного массива t. Аналогичен Шаблон:Scribunto reference, но продолжится до достижения ключа с максимальным числовым значением, в отличе от обычного ipairs, останавливающегося на первом nil. Нечисловые ключи игнорируются.
sparseIpairs может использоваться для цикла for.
for i, v in TableTools.sparseIpairs(t) do
-- Code block
endОбратите внимание, что функция sparseIpairs основана на Шаблон:Scribunto reference. Хота в итератор для цикла могут передаваться не все ключи, читаться будут всё равно все.
size
TableTools.size(t)Возращает размер таблицы пар ключ-значение. Например, для таблицы {foo = 'foo', bar = 'bar'} вызов size вернёт 2. Функция также работает и для массивов, но для них следует использовать встроенный оператор языка #. Обратите внимание, что в своей работе функция использует функцию Шаблон:Scribunto reference для итерирования по всем ключам.
keysToList
TableTools.keysToList(t, keySort)Возвращает список ключей таблицы, используя либо сортировку по умолчанию, либо произвольную функцию keySort, соотвествующую правилам для функции comp для Шаблон:scribunto reference.
sortedPairs
TableTools.sortedPairs(t, keySort)Итератор, перебирающий ключи таблицы в порядке, возвращаемом функцией keysToList. Если в таблице используются только числовые ключи, sparseIpairs будет эффективнее.
isArray
TableTools.isArray(t)Возвращает true, если все ключи таблицы — положительные числа, начиная с 1.
listToSet
TableTools.listToSet(arr)Создаёт множество на основе значений числовых ключей таблицы arr. Получение значения множества для значений 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.loadData, и не имеет возможности не копировать метатаблицы.
sparseConcat
TableTools.sparseConcat(t, sep)Производит конкатенацию всех значений для числовых ключей с сохранением их порядка.
length
TableTools.length(t)Возвращает длину массива или псевдомассива с ключами вида data1, data2 и т.д. Использует алгоритм экспоненциального поиска, поэтому производится минимальное количество обращений.
Алгоритм полезен для массивов с метатаблицами (например, Шаблон:Scribunto reference) и для псевдомассивов. Для обычных массивов предпочтительнее оператор Шаблон:Scribunto reference, реализованный на Си, он будет работать заметно быстрее.
inArray
TableTools.inArray(arr, valueToFind)Возвращает true если valueToFind входит в arr или false иначе.