Template:Mod/doc

[template]documentation subpage[/template]
Implements the mathematical [wiki]modulo[/wiki] operator. The returned result is always of the same sign as the [i]modulus[/i] or nul, and its absolute value is lower than the absolute value of the [i]modulus[/i]. However, this template returns 0 if the [i]modulus[/i] is nul (this template should never return a division by zero error). This template is [b]not[/b] the same as the mod operator in the #expr [wiki="m:Help:ParserFunctions"]parser function[/wiki].
; Usage:
[indent] <code>&#123;&#123;mod|</code>[i]dividend[/i]<code>|</code>[i]modulus[/i]<code>}}</code>[/indent]:: Computes the modulo dynamically.
[indent] <code>&#123;&#123;subst:mod|</code>[i]dividend[/i]<code>|</code>[i]modulus[/i]<code>|subst=subst:}}</code>[/indent]:: Substitute the template invokation by its computed value when saving an article wiki source.
; Examples with positive integer modulus:
[list][*] <code>&#123;&#123;mod&#124;12&#124;10&#125;&#125 ;</code> = [template]mod|12|10[/template].
[*] <code>&#123;&#123;mod&#124;10.1&#124;10&#125;&#125 ;</code> = [template]mod|10.1|10[/template].
[*] <code>&#123;&#123;mod&#124;10&#124;10&#125;&#125 ;</code> = [template]mod|10|10[/template].
[*] <code>&#123;&#123;mod&#124;2&#124;10&#125;&#125; </code> = [template]mod|2|10[/template].
[*] <code>&#123;&#123;mod&#124;0&#124;10&#125;&#125; </code> = [template]mod|0|10[/template].
[*] <code>&#123;&#123;mod&#124;&#45;2&#124;10&#125;&#1 25;</code> = [template]mod|-2|10[/template].
[*] <code>&#123;&#123;mod&#124;&#45;10&#124;10&#125;&# 125;</code> = [template]mod|-10|10[/template].
[*] <code>&#123;&#123;mod&#124;&#45;10.1&#124;10&#125; &#125;</code> = [template]mod|-10.1|10[/template].
[*] <code>&#123;&#123;mod&#124;&#45;12&#124;10&#125;&# 125;</code> = [template]mod|-12|10[/template].
[/LIST]
; Examples with negative integer modulus:
[list][*] <code>&#123;&#123;mod&#124;12&#124;&#45;10&#125;&# 125;</code> = [template]mod|12|-10[/template].
[*] <code>&#123;&#123;mod&#124;10.1&#124;&#45;10&#125; &#125;</code> = [template]mod|10.1|-10[/template].
[*] <code>&#123;&#123;mod&#124;10&#124;&#45;10&#125;&# 125;</code> = [template]mod|10|-10[/template].
[*] <code>&#123;&#123;mod&#124;2&#124;&#45;10&#125;&#1 25;</code> = [template]mod|2|-10[/template].
[*] <code>&#123;&#123;mod&#124;0&#124;&#45;10&#125;&#1 25;</code> = [template]mod|0|-10[/template].
[*] <code>&#123;&#123;mod&#124;&#45;2&#124;&#45;10&#12 5;&#125;</code> = [template]mod|-2|-10[/template].
[*] <code>&#123;&#123;mod&#124;&#45;10&#124;&#45;10&#1 25;&#125;</code> = [template]mod|-10|-10[/template].
[*] <code>&#123;&#123;mod&#124;&#45;10.1&#124;&#45;10& #125;&#125;</code> = [template]mod|-10.1|-10[/template].
[*] <code>&#123;&#123;mod&#124;&#45;12&#124;&#45;10&#1 25;&#125;</code> = [template]mod|-12|-10[/template].
[/LIST]
; Examples with positive non integer modulus:
[list][*] <code>&#123;&#123;mod&#124;21.5&#124;10.5&#125;&#1 25;</code> = [template]mod|21.5|10.5[/template].
[*] <code>&#123;&#123;mod&#124;21.1&#124;10.5&#125;&#1 25;</code> = [template]mod|21.1|10.5[/template].
[*] <code>&#123;&#123;mod&#124;21&#124;10.5&#125;&#125 ;</code> = [template]mod|21|10.5[/template].
[*] <code>&#123;&#123;mod&#124;20.9&#124;10.5&#125;&#1 25;</code> = [template]mod|20.9|10.5[/template].
[*] <code>&#123;&#123;mod&#124;11&#124;10.5&#125;&#125 ;</code> = [template]mod|11|10.5[/template].
[*] <code>&#123;&#123;mod&#124;10.6&#124;10.5&#125;&#1 25;</code> = [template]mod|10.6|10.5[/template].
[*] <code>&#123;&#123;mod&#124;10.5&#124;10.5&#125;&#1 25;</code> = [template]mod|10.5|10.5[/template].
[*] <code>&#123;&#123;mod&#124;10.1&#124;10.5&#125;&#1 25;</code> = [template]mod|10.1|10.5[/template].
[*] <code>&#123;&#123;mod&#124;10&#124;10.5&#125;&#125 ;</code> = [template]mod|10|10.5[/template].
[*] <code>&#123;&#123;mod&#124;2&#124;10.5&#125;&#125; </code> = [template]mod|2|10.5[/template].
[*] <code>&#123;&#123;mod&#124;0&#124;10.5&#125;&#125; </code> = [template]mod|0|10.5[/template].
[*] <code>&#123;&#123;mod&#124;&#45;2&#124;10.5&#125;& #125;</code> = [template]mod|-2|10.5[/template].
[*] <code>&#123;&#123;mod&#124;&#45;10&#124;10.5&#125; &#125;</code> = [template]mod|-10|10.5[/template].
[*] <code>&#123;&#123;mod&#124;&#45;10.1&#124;10.5&#12 5;&#125;</code> = [template]mod|-10.1|10.5[/template].
[*] <code>&#123;&#123;mod&#124;&#45;10.5&#124;10.5&#12 5;&#125;</code> = [template]mod|-10.5|10.5[/template].
[*] <code>&#123;&#123;mod&#124;&#45;10.6&#124;10.5&#12 5;&#125;</code> = [template]mod|-10.6|10.5[/template].
[*] <code>&#123;&#123;mod&#124;&#45;11&#124;10.5&#125; &#125;</code> = [template]mod|-11|10.5[/template].
[*] <code>&#123;&#123;mod&#124;&#45;20.9&#124;10.5&#12 5;&#125;</code> = [template]mod|-20.9|10.5[/template].
[*] <code>&#123;&#123;mod&#124;&#45;21&#124;10.5&#125; &#125;</code> = [template]mod|-21|10.5[/template].
[*] <code>&#123;&#123;mod&#124;&#45;21.1&#124;10.5&#12 5;&#125;</code> = [template]mod|-21.1|10.5[/template].
[*] <code>&#123;&#123;mod&#124;&#45;21.5&#124;10.5&#12 5;&#125;</code> = [template]mod|-21.5|10.5[/template].
[/LIST]
; Examples with nul modulus:
[list][*] <code>&#123;&#123;mod&#124;2&#124;0&#125;&#125;</code> = [template]mod|2|0[/template].
[*] <code>&#123;&#123;mod&#124;0&#124;0&#125;&#125;</code> = [template]mod|0|0[/template].
[*] <code>&#123;&#123;mod&#124;&#45;2&#124;0&#125;&#12 5;</code> = [template]mod|-2|0[/template].
[/LIST]
; See also:
[list][*] [template="Floor"]Floor[/template]
[/LIST]