Module:Utils/doc: Difference between revisions
Jump to navigation
Jump to search
m Updated parameter name |
Added eval_num_arg |
||
| Line 4: | Line 4: | ||
== Functions == | == Functions == | ||
* <code>eval_num_arg(input, def_value)</code> checks if <code>input</code> is a number; on error, use <code>def_value</code>. This function is designed to be used by other modules only; it cannot be called with <code>{{#invoke:}}</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. | * <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, 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. | * <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 05:25, 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
eval_num_arg(input, def_value)checks ifinputis a number; on error, usedef_value. This function is designed to be used by other modules only; it cannot be called withScript error: You must specify a function to call..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.