Module:TableTools/doc

1. перенаправление Шаблон:Рейтинг модуля

Данный модуль предоставляет функции для работы с таблицами Lua. В общем случае, его функции не должны вызываться напрямую через #invoke, а только использоваться в других модулях.

Подключение

Для использования функционала модуль сперва следует подключить. Template:LuaCode

isPositiveInteger

Template:LuaCode Возвращает Template:LuaTrue если Template:Codevar — положительное целое число и Template:LuaFalse иначе. Хотя эта функция и не относится напрямую к таблицам, она нужна для определения, является ли ключ ключом массива либо же хэш-таблицы.

isNan

Template:LuaCode Возвращает Template:LuaTrue если Template:Codevar представляет собой NaN и Template:LuaFalse иначе. Хотя эта функция и не относится напрямую к таблицам, она нужна для определения, может ли значение быть ключом таблицы.

shallowClone

Template:LuaCode Возвращает клон таблицы. Возвращаемое значение представляет собой новую таблицу, но все подтаблицы и функции являются разделяемыми. Метаметоды переносятся, но возвращаемая таблица не будет включать метатаблицу. Если вы хотите скопировать подтаблицы и метатаблицу, используйте Template:Scribunto reference. Если вы хотите скопировать подтаблицы, но не переносить метатаблицы, используйте Template:Code с параметром Template:Code.

removeDuplicates

Template:LuaCode Удаляет из массива значения-дубликаты. Функция предназначена для работы только со стандартными массивами: обрабатываются только ключи-положительные целые числа, а все значения после первого Template:LuaCode игнорируются. (Для массивов, содержащих Template:LuaCode, используйте Template:Code перед этой функцией.) Функция старается сохранить порядок следования элементов — оставляется первое вхождение значения, а все последующие удаляются. Например, для таблицы Template:LuaCode Template:Code вернёт Template:LuaCode.

numKeys

Template:LuaCode Принимает на вход таблицу Template:Codevar и возвращает массив из положительных целых чисел, которые являются ключами таблицы для данных с непустым значением, отсортированный в порядке возрастания. Например, для таблицы Template:LuaCode вызов Template:Code вернёт Template:LuaCode.

affixNums

Template:LuaCode Принимает на вход таблицу Template:Codevar и возвращает массив из положительных целых чисел, которым соответствуют ключи таблицы с опциональным префиксом Template:Codevar и опциональным суффиксом Template:Codevar. Например, для таблицы Template:LuaCode и префикса Template:Codevar вызов Template:Code вернёт Template:LuaCode. Все символы в Template:Codevar и Template:Codevar интерпретируются буквально.

numData

Template:LuaCode Дла таблицы с ключами вида Template:Codevar, Template:Codevar, Template:Codevar и Template:Codevar возвращает таблицы с подтаблицами в формате Template:LuaCode. Ключи, не заканчивающиеся числом размещаются в подтаблице Template:Codevar. Опция Template:Codevar позволяет использовать таблицу для цикла с помощью Template:Code.

compressSparseArray

Template:LuaCode Принимает на вход массив Template:Codevar с пустыми значениями (Template:LuaCode) и убирает их, сохраняя порядок, чтобы массив мог использоваться в Template:Code. Нечисловые ключи удаляются. Например, для таблицы Template:LuaCode вызов Template:Code вернёт Template:LuaCode.

sparseIpairs

Template:LuaCode Итератор для перебора элементов разреженного массива Template:Codevar. Аналогичен Template:Scribunto reference, но продолжится до достижения ключа с максимальным числовым значением, в отличе от обычного Template:Code, останавливающегося на первом Template:LuaCode. Нечисловые ключи игнорируются.

Template:Code может использоваться для цикла Template:Code.

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

size

Template:LuaCode Возращает размер таблицы пар ключ-значение. Например, для таблицы Template:LuaCode вызов Template:Code вернёт Template:Code. Функция также работает и для массивов, но для них следует использовать встроенный оператор языка Template:Code. Обратите внимание, что в своей работе функция использует функцию Template:Scribunto reference для итерирования по всем ключам.

keysToList

Template:LuaCode Возвращает список ключей таблицы, используя либо сортировку по умолчанию, либо произвольную функцию Template:Codevar, соотвествующую правилам для функции Template:Code для Template:Scribunto reference.

sortedPairs

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

isArray

Template:LuaCode Возвращает Template:LuaTrue, если все ключи таблицы — положительные числа, начиная с Template:Code.

listToSet

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

invert

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

deepCopy

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

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

sparseConcat

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

length

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

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

inArray

Template:LuaCode Возвращает Template:LuaTrue если Template:Codevar входит в Template:Codevar или Template:LuaFalse иначе.