Module:Utils/doc

From Xenharmonic Wiki
Revision as of 05:25, 19 August 2022 by Fredg999 (talk | contribs) (Added eval_num_arg)
Jump to navigation Jump to search

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 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 Script error: You must specify a function to call..
  • 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.