Module:Harmonic entropy/doc: Difference between revisions

Revision as of 18:47, 10 July 2024

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.

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.

@@ Line 1: / Line 1: @@
 {{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 a means to calculate harmonic Shannon entropy of a particular interval.
-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.
+It can be called from other modules by using <code>require("Module:Harmonic entropy")</code> and calling the <code>_</code>-prefixed 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>.