Module:Harmonic entropy/doc: Difference between revisions
Jump to navigation
Jump to search
ArrowHead294 (talk | contribs) mNo edit summary |
ArrowHead294 (talk | contribs) mNo edit summary |
||
| Line 1: | Line 1: | ||
{{documentation| | |||
{{dochead|header=none}} | {{dochead|header=none}} | ||
This module provides a means to calculate harmonic Shannon entropy of a particular interval. | This module provides a means to calculate harmonic Shannon entropy of a particular interval. | ||
| Line 6: | Line 7: | ||
== 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>. | ||
}} | |||
Revision as of 14:45, 25 January 2025
This module provides a means to calculate harmonic Shannon entropy of a particular interval.
It can be called from other modules by using require("Module:Harmonic entropy") and calling the _-prefixed functions.
Functions
harmonic_entropy(c, ratios, deviation, norm)computes harmonic Shannon entropy of an interval ofccents acrossratioswith a Gaussian with standarddeviation(also in cents) and anormassociated with theratios.