Modèle:Mod/Documentation

Ceci est la page de documentation de Modèle:Mod [modifier] [purger].

Cette sous-page contient les instructions et les catégories de son modèle d'origine et elle n'est pas destinée à être visualisée directement.

Utilisation[modifier le code]

Ce modèle calcule l’opération mathématique modulo, c’est-à-dire le reste de la division entière d’un ''dividende'' réel quelconque par un ''modulus'' réel non nul. Ce modèle ne doit s'utiliser que dans des cas très spécifique (est un doublon d'une Parse Functions), consultez la documentation avant utilisation.

Paramètres du modèle
Paramètre		Description	Type	État
Dividende	`1`	aucune description	Chaîne	obligatoire
Modulus	`2`	aucune description	Chaîne	obligatoire

La valeur retournée est toujours nulle ou du même signe que le modulus, et sa valeur absolue est toujours inférieure à celle du modulus. Cependant, ce modèle retourne le dividende lui-même si le modulus est nul (ce modèle ne devrait jamais retourner une erreur de division par zéro), de sorte que dans tous les cas, les résultats retournés par ce modèle ou le modèle {{Div}} avec les mêmes paramètres sont complémentaires et permettent de reconstituer le dividende exactement).

Quand utiliser ce modèle ?[modifier le code]

Ce modèle fait la plupart du temps double-emploi avec le mot-clé mod des Parser Functions. Puisqu'il est plus lourd, il ne faut l'utiliser que dans les cas suivants :

le dividende est très grand ;
on souhaite un résultat réel à partir d'opérandes réels (par exemple valeurs de congruence d'un calcul cyclique, calendaire ou trigonométrique) ;
le dividende est négatif^[1].

Différences entre ce modèle et le mot-clé mod des ParserFunctions[modifier le code]

		Avec ce modèle	Avec le mot-clé des ParserFunctions
Opérandes	de valeur non entière	gérés (double précision)	tronqués d'abord en entiers (sur 32 bits signés)
	valeur minimale négative	celle d'un nombre double précision	`PHP_INT_MIN` = −2 147 483 648 (sinon résultat de valeur et signe indéterminé)
	valeur maximale positive	celle d'un nombre double précision	`PHP_INT_MAX` = 2 147 483 647 (sinon résultat de valeur et signe indéterminé)
Valeur retournée	signe	toujours le signe du modulus (en général fixe)	le signe du dividende seulement si les paramètres sont dans les bornes
Valeur retournée	si le modulus est nul	valeur du dividende	erreur (division par zéro)