Module:Harmonic entropy/doc

From Xenharmonic Wiki
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.
  • harmonic_entropy(c, ratios, deviation, norm) computes harmonic Shannon entropy of an interval of c cents across ratios with a Gaussian with standard deviation (also in cents) and a norm associated with the ratios.