Модуль:TableTools/doc

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

Подключение

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

isPositiveInteger

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

isNan

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

shallowClone

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

removeDuplicates

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

numKeys

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

affixNums

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

numData

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

compressSparseArray

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

sparseIpairs

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

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

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

size

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

keysToList

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

sortedPairs

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

isArray

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

listToSet

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

invert

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

deepCopy

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

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

sparseConcat

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

length

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

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

inArray

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