Module:Utils/doc

Revision as of 06:19, 19 August 2022 by Fredg999 (talk | contribs) (Update intro)

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 this module can be called from other modules by using require('Module:Utils') and calling the _-prefixed functions.

Functions

  • eval_num_arg(input, def_value) checks if input is a number; on error, use def_value. This function is designed to be used by other modules only; it cannot be called with {{#invoke:}}.
  • log(x, b) returns the logarithm base b of x. Parameter b defaults to base 2 (octave) if it is omitted.
  • round(x, prec) returns x rounded to a precision of prec decimal places. Parameter prec defaults to 3 if it is omitted.