Module:Utils/doc: Difference between revisions
ArrowHead294 (talk | contribs) No edit summary |
ArrowHead294 (talk | contribs) mNo edit summary |
||
| (6 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{documentation| | {{documentation| | ||
{{dochead|header=none}} | {{dochead|header=none}}{{lua|Arguments|yesno}} | ||
This module provides several mathematical functions which are likely to be used frequently on the Xenharmonic Wiki. | This module provides several mathematical functions which are likely to be used frequently on the Xenharmonic Wiki. | ||
| Line 9: | Line 9: | ||
: Removes leading and trailing whitespaces (but not interior ones) from a string. | : Removes leading and trailing whitespaces (but not interior ones) from a string. | ||
; <code>table_contains(tbl, x)</code>* | ; <code>_yesno(frame)</code> | ||
: Allows [[Module:Yesno]], which is not invokable directly, to be accessed by templates through [[Template:Yesno]]. | |||
; <code>table_contains(tbl, x)</code>* | |||
: Check if table contains x. | : Check if table contains x. | ||
; <code>index_of(array, index)</code>* | ; <code>index_of(array, index)</code>* | ||
: Return the first index with the given value (or nil if not found). | : Return the first index with the given value (or nil if not found). | ||
| Line 18: | Line 21: | ||
: Checks if <code>s</code> is a non-empty string. | : Checks if <code>s</code> is a non-empty string. | ||
; <code>eval_num_arg(input, def_value)</code>* | ; <code>wlink(a, b)</code> | ||
: Provides a link to Wikipedia. | |||
; <code>eval_num_arg(input, def_value)</code>* | |||
: Checks if <code>input</code> is a number; on error, use <code>def_value</code>. | : Checks if <code>input</code> is a number; on error, use <code>def_value</code>. | ||
; <code>log(x, b)</code> | ; <code>log(x, b)</code> | ||
: Returns the logarithm base <code>b</code> of <code>x</code>. Parameter <code>b</code> defaults to base 2 (octave) if it is omitted. | : Returns the logarithm base <code>b</code> of <code>x</code>. Parameter <code>b</code> defaults to base 2 (octave) if it is omitted. | ||
; <code>gcd(a, b)</code> | ; <code>gcd(a, b)</code> | ||
: Returns the greatest common divisor of <code>a</code> and <code>b</code>. | : Returns the greatest common divisor of <code>a</code> and <code>b</code>. | ||
; <code>round_dec(x, places)</code> | ; <code>round_dec(x, places)</code> | ||
: Returns <code>x</code> rounded to a precision of <code>places</code> decimal places. Parameter <code>places</code> defaults to 0 if it is omitted. | : Returns <code>x</code> rounded to a precision of <code>places</code> decimal places. Parameter <code>places</code> defaults to 0 if it is omitted. | ||
; <code>round(x, prec)</code> | ; <code>round(x, prec)</code> | ||
: Returns <code>x</code> rounded to a precision of <code>prec</code> significant figures. Parameter <code>prec</code> defaults to 6 if it is omitted. | : Returns <code>x</code> rounded to a precision of <code>prec</code> significant figures. Parameter <code>prec</code> defaults to 6 if it is omitted. | ||
| Line 46: | Line 52: | ||
; <code>next_young_diagram(d)</code> | ; <code>next_young_diagram(d)</code> | ||
: Returns the next Young diagram of the same size; the first one is <code>[N]</code>, the last one is <code>[1, 1, ..., 1]</code>. After the last one, <code>nil</code> is returned. The input table is modified. | : Returns the next Young diagram of the same size; the first one is <code>[N]</code>, the last one is <code>{{nowrap|[1, 1, ..., 1]}}</code>. After the last one, <code>nil</code> is returned. The input table is modified. | ||
<nowiki />* These functions are designed to be used by other modules only; they cannot be called with <code>{{<nowiki />#invoke:}}</code>. | <nowiki />* These functions are designed to be used by other modules only; they cannot be called with <code>{{<nowiki />#invoke: }}</code>. | ||
}} | }} | ||