# Module:Math/doc

**This is the documentation page for Module:Math**

This Lua module is used on 1,000,000+ pages.To avoid large-scale disruption and unnecessary server load, any changes to this module should first be tested in its /sandbox or /testcases subpages. The tested changes can then be added to this page in one single edit. Please consider discussing any changes on the talk page before implementing them. |

This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |

This module provides a number of mathematical functions. These functions can be used from #invoke or from other Lua modules.

## Use from other Lua modules[edit source | hide | hide all]

To use the module from normal wiki pages, no special preparation is needed. If you are using the module from another Lua module, first you need to load it, like this:

```
local mm = require('Module:Math')
```

(The `mm`

variable stands for **M**odule **M**ath; you can choose something more descriptive if you prefer.)

Most functions in the module have a version for Lua and a version for #invoke. It is possible to use the #invoke functions from other Lua modules, but using the Lua functions has the advantage that you do not need to access a Lua frame object. Lua functions are preceded by `_`

, whereas #invoke functions are not.

## random[edit source | hide]

{{#invoke:math|random}} {{#invoke:math|random|max_value}} {{#invoke:math|random|min_value|max_value}}

```
mm._random()
mm._random(max_value)
mm._random(min_value, max_value)
```

Generates a random number.

- If no arguments are specified, the number produced is greater than or equal to 0 and less than 1.
- If one argument is provided, the number produced is an integer between 1 and that argument. The argument must be a positive integer.
- If two arguments are provided, the number produced is an integer between the first and second arguments. Both arguments must be integers, but can be negative.

This function will not work properly for numbers less than -2^32 and greater than 2^32 - 1 (although this may vary by hardware). If you need to use numbers outside of this range, it is recommended that you use Module:Random.

## order[edit source | hide]

## precision[edit source | hide]

{{#invoke:math|precision|n}} {{#invoke:math|precision|x=n}}

```
mm._precision(number_string)
```

Detemines the precision of a number. For example, for "4" it will return "0", for "4.567" it will return "3", and for "100" it will return "-2".

The function attempts to parse the string representation of the number, and detects whether the number uses E notation. For this reason, when called from Lua, very large numbers or very precise numbers should be directly input as strings to get accurate results. If they are input as numbers, the Lua interpreter will change them to E notation and this function will return the precision of the E notation rather than that of the original number. This is not a problem when the number is called from #invoke, as all input from #invoke is in string format.

## max[edit source | hide]

{{#invoke:math|max|v1|v2|v3|...}}

```
mm._max(v1, v2, v3, ...)
```

Returns the maximum value from the values specified. Values that cannot be converted to numbers are ignored.

## min[edit source | hide]

{{#invoke:math|min|v1|v2|v3|...}}

```
mm._min(v1, v2, v3, ...)
```

Returns the minimum value from the values specified. Values that cannot be converted to numbers are ignored.

## average[edit source | hide]

{{#invoke:math|average|v1|v2|v3|...}}

```
mm._average(v1, v2, v3, ...)
```

Returns the average of the values specified. (More precisely, the value returned is the arithmetic mean.) Values that cannot be converted to numbers are ignored.

## round[edit source | hide]

{{#invoke:math|round|value|precision}} {{#invoke:math|round|value=value|precision=precision}}

```
mm._round(value, precision)
```

Rounds a number to the specified precision.

## mod[edit source | hide]

{{#invoke:math|mod|x|y}}

```
mm._mod(x, y)
```

Gets

modulo *x*

, or the remainder after *y*

has been divided by *x*

. This is accurate for integers up to 2^53; for larger integers Lua's modulo operator may return an erroneous value. This function deals with this problem by returning *y*`0`

if the modulo given by Lua's modulo operator is less than 0 or greater than

.
*y*

## gcd[edit source | hide]

{{#invoke:math|gcd|v1|v2|...}}

```
mm._gcd(v1, v2, ...)
```

Finds the greatest common divisor of the values specified. Values that cannot be converted to numbers are ignored.

## precision_format[edit source | hide]

{{#invoke:math|precision_format|value_string|precision}}

```
mm._precision_format(value_string, precision)
```

Rounds a number to the specified precision and formats according to rules originally used for {{Rnd}}. Output is a string.

## cleanNumber[edit source | hide]

```
local number, number_string = mm._cleanNumber(number_string)
```

`nil, nil`

.