Module:Utils/doc: Difference between revisions

Revision as of 19:04, 10 July 2024

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.

table_contains(tbl, x): Check if table contains x. This function is designed to be used by other modules only; it cannot be called with {{#invoke:}}.

index_of(array, index): Return the first index with the given value (or nil if not found). This function is designed to be used by other modules only; it cannot be called with {{#invoke:}}.

value_provided(s): Checks if s is a non-empty string. This function is designed to be used by other modules only; it cannot be called with {{#invoke:}}.

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:}}.

next_young_diagram(d): Returns the next Young diagram of the same size; the first one is [N], the last one is [1, 1, ..., 1]. After the last one, nil is returned. The input table is modified. This function is designed to be used by other modules only; it cannot be called with {{#invoke:}}.

@@ Line 29: / Line 29: @@
 : 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>{{((}}#invoke:{{))}}</code>.
+; <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>{{((}}#invoke:{{))}}</code>.
-; <code>prime_factorization(n)</code> returns the prime factorization of the given integer <code>n</code> using the exponential form (in wikitext).
+; <code>prime_factorization(n)</code>
+: Returns the prime factorization of the given integer <code>n</code> using the exponential form (in wikitext).
-; <code>prime_factorization_raw(n)</code> returns a table encoding the prime factorization of <code>n</code>. This function is designed to be used by other modules only; it cannot be called with <code>{{((}}#invoke:{{))}}</code>.
+; <code>prime_factorization_raw(n)</code>
+: Returns a table encoding the prime factorization of <code>n</code>. This function is designed to be used by other modules only; it cannot be called with <code>{{((}}#invoke:{{))}}</code>.
 ; <code>signum(x)</code>