Module:TableTools/Documentation

Utilisation

Ce modèle fournit diverses fonction pour effectuer des opérations courantes sur les tableaux lua. Il est prévu pour un usage par d'autres modules et non pour une invocation directe dans un modèle.

Fonctions exportables

Fonctions d'analyse du contenu / des propriétés du tableau

• isPositiveInteger(value) – Prend en argument un objet quelconque et retourne true s'il s'agit d'un nombre entier positif. Cette fonction s'applique à une valeur seule et non à un tableau. Elle est utile pour déterminer si une clé correspond à une clé d'un array (c.-à-d. clé entier positif) ou à une clé de table de hachage (c.-à-d. clé « quelconque »).

• isNan(value) – Prend en argument un objet quelconque et retourne true s'il s'agit de NaN (correspond généralement à un résultat d'opération mathématique non défini, comme 0/0). Cette fonction permet de déterminer si un objet est une clé de tableau valide.

• length(t) – Retourne la longueur d'un tableau, c.-à-d. la première clé telle que la suivante est associée à la valeur nil. Il s'agit de l'équivalent de l'opérateur # prévu pour des tableaux chargés avec mw.loadData.

• size(t) – Retourne la taille d'un tableau, c.-à-d. le nombre de paires clé / valeur qu'il contient.

• isArray(t) – Retourne true si le tableau est un array (les clés sont 1, 2, 3,...) et false sinon.

• inArray(arr, valueToFind) – Retourne true si valueToFind est dans l'array arr et false sinon.

• keysToList(t, keySort, checked) –

• numKeys(t) –

• affixNums(t, prefix, suffix) –

• numData(t, compress) –

Fonctions créant un nouveau tableau

• shallowClone(t) –

• deepCopy(orig, noMetatable, alreadySeen) –

• removeDuplicates(t) –

• compressSparseArray(t) –

• listToSet(arr) –

• invert(t) –

• sparseConcat(t, sep, i, j) –

Fonctions d'itération sur un tableau

• sparseIpairs(t) –

• sortedPairs(t, keySort) –

Modules externes et autres éléments dont ce module a besoin pour fonctionner

• mw.ustring.match – Cherche la première correspondance d'un motif dans une chaine de caractères ;

• libraryUtil – Bibliothèque de fonctions pour retourner une erreur lorsque le type d'un objet n'est pas celui attendu.

Exemple

Pour utiliser les fonctions de ce module, celui-ci doit être importé avec local TableTools = require('Module:TableTools'). Les fonctions sont ensuite utilisables sous le nom TableTools.nomFonction.

local TableTools = require('Module:TableTools')

local p={}

function p.main(tableau)
    if TableTools.isArray(tableau) then
        return "Le tableau est un array."
    else
        return "Le tableau n'est pas un array."
    end
end

return p