Module:Utils/doc: Difference between revisions

Revision as of 05:50, 5 October 2022

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.

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_dec(x, places) returns x rounded to a precision of places decimal places. Parameter places defaults to 0 if it is omitted.
round(x, prec) returns x rounded to a precision of prec significant figures. Parameter prec defaults to 6 if it is omitted.
is_prime(n) returns true if the given integer n is a prime number. This function is designed to be used by other modules only; it cannot be called with {{#invoke:}}.
prime_factorization(n) returns the prime factorization of the given integer n using the exponential form (in wikitext).
prime_factorization_raw(n) returns a table encoding the prime factorization of n. This function is designed to be used by other modules only; it cannot be called with {{#invoke:}}.
signum(x) returns 1 for positive numbers, -1 for negative ones, 0 for zero and non-integer inputs. This function is designed to be used by other modules only; it cannot be called with {{#invoke:}}.

@@ Line 6: / Line 6: @@
 * <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><nowiki>{{#invoke:}}</nowiki></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>round_dec(x, places)</code> returns <code>x</code> rounded to a precision of <code>places</code> decimal places. Parameter <code>places</code> defaults to 0 if it is omitted.
 * <code>round(x, prec)</code> returns <code>x</code> rounded to a precision of <code>prec</code> significant figures. Parameter <code>prec</code> defaults to 6 if it is omitted.
 * <code>is_prime(n)</code> returns <code>true</code> if the given integer <code>n</code> is a prime number. This function is designed to be used by other modules only; it cannot be called with <code><nowiki>{{#invoke:}}</nowiki></code>.