Module:Utils/doc
This is the documentation page for Module:Utils
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 ifinput
is a number; on error, usedef_value
. This function is designed to be used by other modules only; it cannot be called with{{#invoke:}}
.log(x, b)
returns the logarithm baseb
ofx
. Parameterb
defaults to base 2 (octave) if it is omitted.round(x, prec)
returnsx
rounded to a precision ofprec
decimal places. Parameterprec
defaults to 3 if it is omitted.