Модуль:TableTools/doc
Это страница документации Модуль:TableTools.
Этот модуль относится к критическим. У него очень много включений или он используется с подстановкой. Из-за опасности вандализма или ошибочного редактирования он был защищён. |
Данный модуль предоставляет функции для работы с таблицами Lua. В общем случае, его функции не должны вызываться напрямую через #invoke, а только использоваться в других модулях.
Подключение[править]
Для использования функционала модуль сперва следует подключить. КатегорияШаблоны:Языки программирования
isPositiveInteger[править]
КатегорияШаблоны:Языки программирования
Возвращает
КатегорияШаблоны:Языки программирования если value
— положительное целое число и
КатегорияШаблоны:Языки программирования иначе. Хотя эта функция и не относится напрямую к таблицам, она нужна для определения, является ли ключ ключом массива либо же хэш-таблицы.
isNan[править]
КатегорияШаблоны:Языки программирования
Возвращает
КатегорияШаблоны:Языки программирования если value
представляет собой NaN и
КатегорияШаблоны:Языки программирования иначе. Хотя эта функция и не относится напрямую к таблицам, она нужна для определения, может ли значение быть ключом таблицы.
shallowClone[править]
КатегорияШаблоны:Языки программирования
Возвращает клон таблицы. Возвращаемое значение представляет собой новую таблицу, но все подтаблицы и функции являются разделяемыми. Метаметоды переносятся, но возвращаемая таблица не будет включать метатаблицу. Если вы хотите скопировать подтаблицы и метатаблицу, используйте mw.clone
. Если вы хотите скопировать подтаблицы, но не переносить метатаблицы, используйте [[#deepCopy|deepCopy]]
с параметром noMetatable
.
removeDuplicates[править]
КатегорияШаблоны:Языки программирования
Удаляет из массива значения-дубликаты. Функция предназначена для работы только со стандартными массивами: обрабатываются только ключи-положительные целые числа, а все значения после первого
КатегорияШаблоны:Языки программирования игнорируются. (Для массивов, содержащих
КатегорияШаблоны:Языки программирования, используйте [[#compressSparseArray|compressSparseArray]]
перед этой функцией.) Функция старается сохранить порядок следования элементов — оставляется первое вхождение значения, а все последующие удаляются. Например, для таблицы
КатегорияШаблоны:Языки программирования removeDuplicates
вернёт
КатегорияШаблоны:Языки программирования.
numKeys[править]
КатегорияШаблоны:Языки программирования
Принимает на вход таблицу t
и возвращает массив из положительных целых чисел, которые являются ключами таблицы для данных с непустым значением, отсортированный в порядке возрастания. Например, для таблицы
КатегорияШаблоны:Языки программирования вызов numKeys
вернёт
КатегорияШаблоны:Языки программирования.
affixNums[править]
КатегорияШаблоны:Языки программирования
Принимает на вход таблицу t
и возвращает массив из положительных целых чисел, которым соответствуют ключи таблицы с опциональным префиксом prefix
и опциональным суффиксом suffix
. Например, для таблицы
КатегорияШаблоны:Языки программирования и префикса a
вызов affixNums
вернёт
КатегорияШаблоны:Языки программирования. Все символы в prefix
и suffix
интерпретируются буквально.
numData[править]
КатегорияШаблоны:Языки программирования
Дла таблицы с ключами вида foo1
, bar1
, foo2
и baz2
возвращает таблицы с подтаблицами в формате
КатегорияШаблоны:Языки программирования. Ключи, не заканчивающиеся числом размещаются в подтаблице other
. Опция compress
позволяет использовать таблицу для цикла с помощью ipairs
.
compressSparseArray[править]
КатегорияШаблоны:Языки программирования
Принимает на вход массив t
с пустыми значениями (
КатегорияШаблоны:Языки программирования) и убирает их, сохраняя порядок, чтобы массив мог использоваться в ipairs
. Нечисловые ключи удаляются. Например, для таблицы
КатегорияШаблоны:Языки программирования вызов compressSparseArray
вернёт
КатегорияШаблоны:Языки программирования.
sparseIpairs[править]
КатегорияШаблоны:Языки программирования
Итератор для перебора элементов разреженного массива t
. Аналогичен ipairs
, но продолжится до достижения ключа с максимальным числовым значением, в отличе от обычного ipairs
, останавливающегося на первом
КатегорияШаблоны:Языки программирования. Нечисловые ключи игнорируются.
sparseIpairs
может использоваться для цикла for
.
КатегорияШаблоны:Языки программирования
Обратите внимание, что функция sparseIpairs
основана на pairs
. Хота в итератор для цикла могут передаваться не все ключи, читаться будут всё равно все.
size[править]
КатегорияШаблоны:Языки программирования
Возращает размер таблицы пар ключ-значение. Например, для таблицы
КатегорияШаблоны:Языки программирования вызов size
вернёт 2
. Функция также работает и для массивов, но для них следует использовать встроенный оператор языка #
. Обратите внимание, что в своей работе функция использует функцию pairs
для итерирования по всем ключам.
keysToList[править]
КатегорияШаблоны:Языки программирования
Возвращает список ключей таблицы, используя либо сортировку по умолчанию, либо произвольную функцию keySort
, соотвествующую правилам для функции comp
для table.sort
.
sortedPairs[править]
КатегорияШаблоны:Языки программирования
Итератор, перебирающий ключи таблицы в порядке, возвращаемом функцией keysToList
. Если в таблице используются только числовые ключи, sparseIpairs
будет эффективнее.
isArray[править]
КатегорияШаблоны:Языки программирования
Возвращает
КатегорияШаблоны:Языки программирования, если все ключи таблицы — положительные числа, начиная с 1
.
listToSet[править]
КатегорияШаблоны:Языки программирования
Создаёт множество на основе значений числовых ключей таблицы arr
. Получение значения множества для значений arr
вернёт
КатегорияШаблоны:Языки программирования.
КатегорияШаблоны:Языки программирования
invert[править]
КатегорияШаблоны:Языки программирования
Транспонирует ключи и значения массива. Например, invert{ "a", "b", "c"
} вернёт { a = 1, b = 2, c = 3
}. Работает только для числовых ключей.
deepCopy[править]
КатегорияШаблоны:Языки программирования
Создаёт копию таблицы orig
. Как и при использовании mw.clone
все значения, не являющиеся функциями, дублируются и идентичность таблиц сохраняется. Если noMetatable
выставляется в
КатегорияШаблоны:Языки программирования, метатаблица (если имеется) не копируется. Может копировать таблицы, загруженные с помощью mw.loadData
.
В отличие от этой функции mw.clone
не работает с таблицами, загруженными с помощью mw.loadData
, и не имеет возможности не копировать метатаблицы.
sparseConcat[править]
КатегорияШаблоны:Языки программирования Производит конкатенацию всех значений для числовых ключей с сохранением их порядка.
length[править]
КатегорияШаблоны:Языки программирования
Возвращает длину массива или псевдомассива с ключами вида data1
, data2
и т.д. Использует алгоритм экспоненциального поиска, поэтому производится минимальное количество обращений.
Алгоритм полезен для массивов с метатаблицами (например, frame.args
) и для псевдомассивов. Для обычных массивов предпочтительнее оператор #
, реализованный на Си, он будет работать заметно быстрее.
inArray[править]
КатегорияШаблоны:Языки программирования
Возвращает
КатегорияШаблоны:Языки программирования если valueToFind
входит в arr
или
КатегорияШаблоны:Языки программирования иначе.