Module:Harmonic entropy/doc: Difference between revisions

Sintel (talk | contribs)
No edit summary
ArrowHead294 (talk | contribs)
Replace with template
Line 1: Line 1:
{{dochead}}
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.


Line 5: Line 6:
== 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>.
<includeonly><hr><small>Documentation transcluded from [[/doc]]</small> [[Category:Lua modules]]</includeonly>