Модуль:TableTools/doc

Шаблон: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. Если вы хотите скопировать подтаблицы, но не переносить метатаблицы, используйте Шаблон:code с параметром Шаблон:code.

removeDuplicates

TableTools.removeDuplicates(t)

Удаляет из массива значения-дубликаты. Функция предназначена для работы только со стандартными массивами: обрабатываются только ключи-положительные целые числа, а все значения после первого nil игнорируются. (Для массивов, содержащих nil, используйте Шаблон:code перед этой функцией.) Функция старается сохранить порядок следования элементов — оставляется первое вхождение значения, а все последующие удаляются. Например, для таблицы {5, 4, 4, 3, 4, 2, 2, 1} Шаблон:code вернёт {5, 4, 3, 2, 1}.

numKeys

TableTools.numKeys(t)

Принимает на вход таблицу Шаблон:codevar и возвращает массив из положительных целых чисел, которые являются ключами таблицы для данных с непустым значением, отсортированный в порядке возрастания. Например, для таблицы {'foo', nil, 'bar', 'baz', a = 'b'} вызов Шаблон:code вернёт {1, 3, 4}.

affixNums

TableTools.affixNums(t, prefix, suffix)

Принимает на вход таблицу Шаблон:codevar и возвращает массив из положительных целых чисел, которым соответствуют ключи таблицы с опциональным префиксом Шаблон:codevar и опциональным суффиксом Шаблон:codevar. Например, для таблицы {a1 = 'foo', a3 = 'bar', a6 = 'baz'} и префикса Шаблон:codevar вызов Шаблон:code вернёт {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 позволяет использовать таблицу для цикла с помощью Шаблон:code.

compressSparseArray

TableTools.compressSparseArray(t)

Принимает на вход массив Шаблон:codevar с пустыми значениями (nil) и убирает их, сохраняя порядок, чтобы массив мог использоваться в Шаблон:code. Нечисловые ключи удаляются. Например, для таблицы {1, nil, foo = 'bar', 3, 2} вызов Шаблон:code вернёт {1, 3, 2}.

sparseIpairs

TableTools.sparseIpairs(t)

Итератор для перебора элементов разреженного массива Шаблон:codevar. Аналогичен Шаблон:scribunto reference, но продолжится до достижения ключа с максимальным числовым значением, в отличе от обычного Шаблон:code, останавливающегося на первом nil. Нечисловые ключи игнорируются.

Шаблон:code может использоваться для цикла Шаблон:code.

for i, v in TableTools.sparseIpairs(t) do
   -- code block
end

Обратите внимание, что функция Шаблон:code основана на Шаблон:scribunto reference. Хота в итератор для цикла могут передаваться не все ключи, читаться будут всё равно все.

size

TableTools.size(t)

Возращает размер таблицы пар ключ-значение. Например, для таблицы {foo = 'foo', bar = 'bar'} вызов Шаблон:code вернёт Шаблон:code. Функция также работает и для массивов, но для них следует использовать встроенный оператор языка Шаблон:code. Обратите внимание, что в своей работе функция использует функцию Шаблон:scribunto reference для итерирования по всем ключам.

keysToList

TableTools.keysToList(t, keySort)

Возвращает список ключей таблицы, используя либо сортировку по умолчанию, либо произвольную функцию Шаблон:codevar, соотвествующую правилам для функции Шаблон:code для Шаблон:scribunto reference.

sortedPairs

TableTools.sortedPairs(t, keySort)

Итератор, перебирающий ключи таблицы в порядке, возвращаемом функцией Шаблон:code. Если в таблице используются только числовые ключи, Шаблон:code будет эффективнее.

isArray

TableTools.isArray(t)

Возвращает true, если все ключи таблицы — положительные числа, начиная с Шаблон:code.

listToSet

TableTools.listToSet(arr)

Создаёт множество на основе значений числовых ключей таблицы Шаблон:codevar. Получение значения множества для значений Шаблон:codevar вернёт true.

local set = TableTools.listToSet { "a", "b", "c" }
assert(set["a"] == true)

invert

TableTools.invert(t)

Транспонирует ключи и значения массива. Например, Шаблон:code} вернёт Шаблон:code}. Работает только для числовых ключей.

deepCopy

TableTools.deepCopy(orig, noMetatable, alreadySeen)

Создаёт копию таблицы Шаблон:codevar. Как и при использовании Шаблон:code все значения, не являющиеся функциями, дублируются и идентичность таблиц сохраняется. Если Шаблон:codevar выставляется в true, метатаблица (если имеется) не копируется. Может копировать таблицы, загруженные с помощью Шаблон:code.

В отличие от этой функции Шаблон:code не работает с таблицами, загруженными с помощью Шаблон:code, и не имеет возможности не копировать метатаблицы.

sparseConcat

TableTools.sparseConcat(t, sep)

Производит конкатенацию всех значений для числовых ключей с сохранением их порядка.

length

TableTools.length(t)

Возвращает длину массива или псевдомассива с ключами вида Шаблон:code, Шаблон:code и т.д. Использует алгоритм экспоненциального поиска, поэтому производится минимальное количество обращений.

Алгоритм полезен для массивов с метатаблицами (например, Шаблон:scribunto reference) и для псевдомассивов. Для обычных массивов предпочтительнее оператор Шаблон:scribunto reference, реализованный на Си, он будет работать заметно быстрее.

inArray

TableTools.inArray(arr, valueToFind)

Возвращает true если Шаблон:codevar входит в Шаблон:codevar или false иначе.