Module:Harmonic entropy/doc: Difference between revisions

Revision as of 22:24, 30 October 2025

{{documentation|

library}

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.

To see introspection summary, see this module's main page.''

@@ Line 1: / Line 1: @@
 {{documentation|
-{{dochead|header=none}}{{lua|Limits|Rational}}
+{{dochead|header=library}
 This module provides a means to calculate harmonic Shannon entropy of a particular interval.
 It can be called from other modules by using <code>require("Module:Harmonic entropy")</code> and calling the <code>_</code>-prefixed functions.
-=== Functions ===
+{{module introspection}}
-; <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>.
 }}