Module:Utils/doc: Difference between revisions
Jump to navigation
Jump to search
Created page with "This module provides several mathematical functions which are likely to be used frequently on the Xenharmonic Wiki. Namely, the functions in these modules can be called from..." |
m Updated parameter name |
||
| Line 5: | Line 5: | ||
== Functions == | == Functions == | ||
* <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. | * <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. | ||
* <code>round(x, | * <code>round(x, prec)</code> returns <code>x</code> rounded to a precision of <code>prec</code> decimal places. Parameter <code>prec</code> defaults to 3 if it is omitted. | ||
<includeonly><hr><small>Documentation transcluded from [[/doc]]</small> [[Category:Lua modules]]</includeonly> | <includeonly><hr><small>Documentation transcluded from [[/doc]]</small> [[Category:Lua modules]]</includeonly> | ||
Revision as of 04:21, 19 August 2022
This module provides several mathematical functions which are likely to be used frequently on the Xenharmonic Wiki.
Namely, the functions in these modules can be called from other modules using the require('Module:xyz') function.
Functions
log(x, b)returns the logarithm basebofx. Parameterbdefaults to base 2 (octave) if it is omitted.round(x, prec)returnsxrounded to a precision ofprecdecimal places. Parameterprecdefaults to 3 if it is omitted.