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