Module:Math/doc: Difference between revisions

{{High-risk|1,607,000+}}

{{module rating|protected}}

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

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 <code>mm</code> variable stands for '''M'''odule '''M'''ath; you can choose something more descriptive if you prefer.)

  &#123;{#invoke:math|random|''min_value''|''max_value''}}

mm._random()

mm._random(max_value)

mm._random(min_value, max_value)

Generates a random number.

  &#123;{#invoke:math|order|''n''}}

mm._order(n)

Determines the [[order of magnitude]] of a number.

  &#123;{#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".

  &#123;{#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.

== median  ==

mm._median(v1, v2, v3, ...)

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

  &#123;{#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.

  &#123;{#invoke:math|sum|''v1''|''v2''|''v3''|...}}

mm._sum(v1, v2, v3, ...)

Returns the sum of the values specified. Values that cannot be converted to numbers are ignored.

  &#123;{#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 [[Mean#Arithmetic mean (AM)|arithmetic mean]].) Values that cannot be converted to numbers are ignored.

  &#123;{#invoke:math|round|value=''value''|precision=''precision''}}

mm._round(value, precision)

== log10 ==

  &#123;{#invoke:math | log10 | ''x''}}

mm._log10(x)

Returns <code>log₁₀(''x'')</code>, the [[logarithm]] of ''x'' using base 10.

  &#123;{#invoke:math|mod|''x''|''y''}}

mm._mod(x, y)

Gets <code>''x''</code> [[Modulo operation|modulo]] <code>''y''</code>, or the remainder after <code>''x''</code> has been divided by <code>''y''</code>. This is accurate for integers up to 2⁵³; for larger integers Lua's modulo operator may return an erroneous value. This function deals with this problem by returning <code>0</code> if the modulo given by Lua's modulo operator is less than 0 or greater than <code>''y''</code>.

  &#123;{#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.

  &#123;{#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 {{tl|Rnd}}.  Output is a string.

== cleanNumber ==

local number, number_string = mm._cleanNumber(number_string)

A helper function that can be called from other Lua modules, but not from #invoke. This takes a string or a number value as input, and if the value can be converted to a number, cleanNumber returns the number and the number string. If the value cannot be converted to a number, cleanNumber returns <code>nil, nil</code>.