Module:Harmonic entropy/doc: Difference between revisions
m FloraC moved page Module:Interval/doc to Module:Harmonic entropy/doc without leaving a redirect: See talk |
ArrowHead294 (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
{{dochead}} | {{dochead|header=none}} | ||
This module provides several functions to work with [[interval]]-related math. Currently, it only exists to calculate the harmonic entropy. | This module provides several functions to work with [[interval]]-related math. Currently, it only exists to calculate the harmonic entropy. | ||
Namely, the functions in this module can be called from other modules by using <code>require('Module: | Namely, the functions in this module can be called from other modules by using <code>require('Module:Harmonic entropy')</code> and calling the <code>_</code>-prefixed functions. | ||
== Functions == | == Functions == | ||
* <code>harmonic_entropy(c, ratios, deviation, norm)</code> computes [[Harmonic entropy#Basic Model: Shannon Entropy|harmonic Shannon entropy]] of an interval of <code>c</code> [[cent]]s across <code>ratios</code> with a Gaussian with standard <code>deviation</code> (also in [[cent]]s) and a <code>norm</code> associated with the <code>ratios</code>. | * <code>harmonic_entropy(c, ratios, deviation, norm)</code> computes [[Harmonic entropy#Basic Model: Shannon Entropy|harmonic Shannon entropy]] of an interval of <code>c</code> [[cent]]s across <code>ratios</code> with a Gaussian with standard <code>deviation</code> (also in [[cent]]s) and a <code>norm</code> associated with the <code>ratios</code>. | ||