Help:Calculation

The MediaWiki extension ParserFunctions enables users to perform simple mathematical computations.

The expr function evaluates numerical expressions, and also boolean expressions involving numbers and booleans (not strings). The syntax is:

The spaces are not needed. Inside numbers no spaces are allowed.

The supported operators (roughly in order of precedence) are not, *, /, div, mod, +, -, round, =, <>, !=, <=, >=, and, and or.

Operators

Operator	Operation	Example
none		Template:Evaldemo Template:Evaldemo
+	Unary `+` sign	Template:Evaldemo
-	Unary `-` sign (negation)	Template:Evaldemo
not	Unary NOT, logical NOT	Template:Evaldemo Template:Evaldemo
*	Multiplication	Template:Evaldemo
/	Division, same as div	Template:Evaldemo
div	Division, same as /, no integer division	Template:Evaldemo (should be 4) Template:Evaldemo (should be 5)
mod	"Modulo", remainder of division after truncating both operands to an integer. Caveat, div and mod are different from all programming languages. This has been fixed (but needs to be committed), see bugzilla:6068.	Template:Evaldemo Template:Evaldemo Template:Evaldemo Template:Evaldemo (should be 2.6) Template:Evaldemo (should be 1.6) Template:Evaldemo (should be 2.9)
`+`	Addition	Template:Evaldemo
`-`	Subtraction	Template:Evaldemo
round	Rounds off the number on the left to the power of 1/10 given on the right	Template:Evaldemo Template:Evaldemo {{ `#expr: 3456 round -2`}} = 3500
=	Equality (numerical incl. logical)	Template:Evaldemo
<>	Inequality, same as !=	Template:Evaldemo
!=	Inequality, same as <>, logical xor	Template:Evaldemo
<	Less than	Template:Evaldemo
>	Greater than	Template:Evaldemo
<=	Less than or equal to	Template:Evaldemo
>=	Greater than or equal to	Template:Evaldemo
and	Logical AND	Template:Evaldemo
or	Logical OR	Template:Evaldemo

The boolean operators consider 0 to be false and any other number to be true. An intermediate or final result "true" is identified with 1. Thus Template:Evaldemo.

Precedence:

Template:Evaldemo

(+ and - have equal precedence, * and / also, both higher than the former two).

Template:Evaldemo

(first +, then =, then <).

Template:Evaldemo

(first additions, then round)

Template:Evaldemo

(mod and multiplication have equal precedence, evaluation from left to right)

Parentheses can force a different precedence: Template:Evaldemo

Blank spaces are good for readability but not needed for working properly, except between not and an adjacent and/div/mod/not/or/round operator, and within numbers not allowed:

{{#expr:7mod3}} gives 1
{{#expr:7.5round0}} gives 8
{{#expr:0and1}} gives 0
{{#expr:0or not0}} gives 1
{{#expr:0ornot0}} gives Expression error: Unrecognized word "ornot".
{{#expr:123 456}} gives Expression error: Unexpected number.
{{#expr:not not3}} gives 1
{{#expr:notnot3}} gives Expression error: Unrecognized word "notnot".

{{#expr:---2}} gives -2
{{#expr:-+-2}} gives 2
{{#expr:2*-3}} gives -6
{{#expr:-not-not-not0}} gives -1
{{#expr:2*/3}} gives Expression error: Unexpected / operator.

Numbers as input

Leading zeros are allowed, as well as a trailing decimal point (for an integer) and trailing zeros in a number with a decimal point.

These equivalences are also relevant for #ifeq and #switch, see below.

Scientific notation and group separators are not accepted in input for expressions:

Due to the specifier R ("raw"), {{NUMBEROFARTICLES|R}} = Template:NUMBEROFARTICLES etc. produce numbers without group separators, which can be used in computations.

Numbers as output

A non-integer result has a decimal point in it. Scientific notation is produced for numbers with absolute value less than 1E-4 and for numbers with absolute value greater than or equal to 1E+12. Thus numbers produced include:

Since scientific notation is not accepted as input, nested use of #expr may fail in cases where the same composite computation with a single #expr works.

Thus:: Template:Evaldemo,; Template:Evdn,; Template:Evaldemo, but; Template:Evdn.
Long YYYYMMDDhhmmss timestamps can run into the same problem:: Template:Evaldemo,; Template:Evdn.
Timestamps without seconds are 12 digits, just short enough:: Template:Evaldemo

See template:evalint ( talk edit history links ) for producing output of large integers in non-scientific notation, suitable as input in another computation. For producing numbers with commas as group separators, see template:csn ( talk edit history links ).

If the result of rounding a negative number is zero, the result is "-0". To avoid that, an expression x can be replaced by 0 + ( x ):

Accuracy

Accuracy of the result of #expr is less than internally used within the computation of an expression:

Template:Evaldemo
Template:Evaldemo
Template:Evdn
Template:Evaldemo (conclusion: 16 or 17 digits of 1234567890.1234567890 used)
Template:Evaldemo (result is rounded to a total of 12 digits)
Template:Evdn

The macheps or smallest x such that 1+x != 1 appears to be near 0.5^53 + 0.5^106 or 1.1102230246251566636831481088739149080825883E-16 (see above):
Template:Evaldemo
Template:Evaldemo

That's the normal behaviour for 64=1+52+11 bits (52 mantissa, 11 exponent). As explained above it is unrelated to the smallest expression result greater than 1:
Template:Evaldemo
Template:Evaldemo below about 1 + 5E-12.

Branching depending on an expression

The function #ifexpr produces one of two specified results, depending on the value of a boolean expression involving numbers and booleans (not strings). Example:

{{#ifexpr: {{CURRENTDOW}} = 0 or {{CURRENTDOW}} = 6 | weekend | Mo-Fr}} yields Mo-Fr because today is Friday with {{CURRENTDOW}} = 5.

Comparisons

The function #ifeq: compares numbers and strings for equality (equal if both represent the same number or both are equal strings).
The function #switch: compares one string with multiple others, and correspondingly produces one of multiple specified results.

{{#switch:FR|UK=London|FR=Paris|NL=Amsterdam}} gives NL=Amsterdam
{{#switch:UK|UK|GB=London|FR=Paris}} gives FR=Paris
{{#switch:ZZ|UK=London|FR=Paris|no match}} gives no match

{{#ifeq:3|3.0|1|0}} gives 1
{{#ifeq:3|03|1|0}} gives 1
{{#ifeq:0.00003456|3.456E-05|1|0}} gives 1
Note that #ifeq: unlike #expr: accepts exponential notation on input.
{{#ifeq:1234567890123|1234567890120|1|0}} gives 0
{{#ifeq:1234567890123|1.23456789012E+12|1|0}} gives 0
{{#ifeq:1234567890120|1.23456789012E+12|1|0}} gives 1
{{#ifeq:1.234567890120E12|1.23456789012E+12|1|0}} gives 1
Numerical comparisons don't depend on the output format, compare:
{{#expr:1234567890123}} gives 1234567890123
{{#expr:1234567890120}} gives 1234567890120

#ifeq: allows to compare strings containing equal signs:

#switch:	result	#ifeq:	result
{{`#switch:-1.0\|-1=okay\|fail`}}	fail	{{`#ifeq:-1.0\|-1\|okay\|fail`}}	okay
{{`#switch:a=b\|a=b=okay\|fail`}}	fail	{{`#ifeq:a=b\|a=b\|okay\|fail`}}	okay
{{`#switch:a=c\|a=b=fail\|okay`}}	okay	{{`#ifeq:a=c\|a=b\|fail\|okay`}}	okay

Length of expressions

To find the absolute value of a numeric expression x without using a separate template at least doubles the length of the expression:

x*(1-2*(x<0))
x*{{#ifexpr:x>0|1|-1}}

(The first is not only shorter but has also the advantage that for substitution one less "subst:" or {{{subst|}}} is needed.)

Do not use

{{#ifexpr:x>0|x|-x}}

for long expressions as it triples the length.

Similarly do not use mod to round or conversely, because it doubles the length of the expression.

Also providing a leading zero for the result of an expression if it is less than 10 doubles its length:

{{#ifexpr:x<10|0}}x

This "exponential" growth of expressions, with much repetition, is due to the lack of variables (in the computer programming sense). Templates (subroutines) provide some of the functionality that variables offer, but fetching them from the database can be slower than evaluating even a long expression.

If the number of possible results of a long expression is small, a switch allows arbitrary conversion, including the absolute value and providing a leading zero, etc., without repeating the expression.

Error messages

Examples for all known #expr: and #ifexpr: error messages
Expression	Error message
Template:Evaldemo
Template:Evaldemo
Template:Evaldemo
Template:Evaldemo
Template:Evaldemo
Template:Evaldemo
Template:Evaldemo
Template:Evaldemo
Template:Evaldemo
Template:Evaldemo
Template:Evaldemo
Template:Evaldemo
{{ `#expr:`{{ `x\|102\|1000*`}} `18` }} gives 1.8E+307
{{ `#expr:`{{ `x\|102\|1000*`}} `179` }} gives 1.79E+308
{{ `#expr:`{{ `x\|102\|1000*`}} `180` }} gives INF
{{ `#expr:`{{ `x\|33\|(1+(`}} `1` {{ `x\|33\|))`}} }} gives 34
{{ `#expr:`{{ `x\|34\|(1+(`}} `1` {{ `x\|34\|))`}} }} gives Expression error: Stack exhausted.
Template:Evaldemo (no feature, only an oddity)

Note: template:x ( talk edit history links ) copies a given string, here parts of an expression, for the specified times (max. 120), this help page shown on other projects actually evaluate its substituted output like 102 factors "1000" times "180" to get INF (infinity).

Wikitext without error message from the parser functions, but typically an error while using or attempting to use them:

{{{#expr:2*3}}}	{{{#expr:2*3}}}	(triple braces, the whole is interpreted as parameter tag with parameter name "#expr:2*3")
{{#expr:2*3}}}	6}	(one closing brace too many; the last of the three is interpreted as plain text, so that the rest works fine)
{{{#expr:2*3}}	{6	(one opening brace too many; the first of the three is interpreted as plain text, so that the rest works fine)
{{#expr:2*3}	{{#expr:2*3}	(too few braces, the whole is interpreted as plain text)

A crude but informative "unrecognised word" error message can be generated intentionally. Only the first identified error is shown:

{{ #expr: 2*{{ #ifexpr: 3*4>10|toolarge|3*4 }} }} gives

Expression error: Unrecognized word "toolarge".,

{{ #expr: 2*{{ #ifexpr: 3*4>10|too large|3*4 }} }} gives

Expression error: Unrecognized word "too"..

lensowiki ^β

Help:Calculation

Operators

Numbers as input

Numbers as output

Accuracy

Branching depending on an expression

Comparisons

Length of expressions

Error messages

See also

lensowiki β

Help:Calculation

Operators

Numbers as input

Numbers as output

Accuracy

Branching depending on an expression

Comparisons

Length of expressions

Error messages

See also

lensowiki ^β