Module:Harmonic entropy/doc

From Xenharmonic Wiki
Revision as of 21:23, 21 August 2022 by Fredg999 (talk | contribs) (Improve description)
Jump to navigation Jump to search

This is the documentation page for Module:Harmonic entropy

This module provides several functions to work with interval-related math.

Namely, the functions in this module can be called from other modules by using require('Module:Interval') and calling the _-prefixed functions.

Functions

  • to_cents(ratio, prec) returns the measure in cents of an interval ratio, rounded to a precision of prec decimal places. Parameter prec defaults to 3 if it is omitted.
  • parse_ET(input) returns the size (number of divisions) and the equave of an equal tuning given its name. Currently only supports equal divisions (e.g. no 88cET yet). This function is designed to be used by other modules only; it cannot be called with {{#invoke:}}.
  • backslash_ratio(input) returns the ratio corresponding to an interval written in backslash notation.