`$math.avg`¶

Alias: $math.average

Description¶

Calcule une moyenne de valeurs. La méthode supporte plusieurs formats de données en entrée:

une valeur litérale: Dans cas, la méthode n'a rien à calculer et elle ne fait que de retourner la valeur reçue
un tableau 1D de valeurs litérales: La méthode calcule la moyenne des valeurs du tableau et retourne une valeur litérale
un tableau 2D de valeurs litérales: La méthode calcule la moyenne par colonnes et retourne un tableau 1D. La méthode s'attend à ce que chaque sous-tableau contienne le même nombre de valeurs, ou dit autrement : que la matrice possède des valeurs sur toutes les colonnes. Les données manquantes sont interprétées comme des 0. Ainsi, la valeur calculée pour une matrice [ [1, 2], [3] ] sera [ 2, 1 ] (ce qui correspond à [ (1 + 3) / 2, (2 + 0) / 2 ])
un map: La méthode ne fait que de filtrer le map en fonction du paramètre filter (si défini) et retourne un map
un tableau de map: La méthode calcule la moyenne par propriété (en tenant compte du paramètre filter et retourne un map

Syntaxe¶

$math.avg( data [ , filter [ , options ] ] )

Paramètres¶

data number / array / map

Jeu de données dont on souhaite calculer la moyenne

options map

Map d'options. Les options reconnues sont:

filter number / array

Cette option est prise en compte lorsque le paramètre data désigne un map. Elle permet d'indiquer la ou les propriétés pour lesquelles la méthode doit calculer une moyenne. Le map en sortie ne contiendra que les propriétés énumérées dans filter.

ignoreNullboolean

Flag indiquant d'ignorer les valeurs null pour le calcul.

Lorsqu'il n'est pas activé (c'est le comportement par défaut), le flag interprète les valeurs null comme des 0. Ainsi la moyenne calculée pour le tableau 2D [[1,2],[3,null]] est [2,1].
Lorsqu'il est activé, le flag ignore les valeurs null dans le calcul de la moyenne, ainsi la moyenne calculée pour un tableau 2D [[1,2],[3,null]] est [2,2]

Par défaut le flag est false.

defaultValue any

Valeur par défaut à retourner en lieu et place des valeurs dont le calcul de la moyenne donne un résultat null. Par défaut la valeur de retour est null.

Retour¶

Valeur de type number, array ou map contenant la moyenne des éléments reçus en entrée. Le format de la sortie dépend du format des données en entrée et de la nature du filter.

Exemple¶

Non disponible

$math.avg¶