Module:Harmonic entropy/doc: Difference between revisions

Line 1:

This module provides several functions to work with [[interval]]-related math.

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:Interval')</code> and calling the <code>_</code>-prefixed functions.

== Functions ==

* <code>to_cents(ratio, prec)</code> returns the measure in [[cent]]s of an interval [[ratio]], rounded to a precision of <code>prec</code> decimal places. Parameter <code>prec</code> defaults to 3 if it is omitted.

* <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>

@@ Line 1: / Line 1: @@
-This module provides several functions to work with [[interval]]-related math.
+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:Interval')</code> and calling the <code>_</code>-prefixed functions.
 == Functions ==
-* <code>to_cents(ratio, prec)</code> returns the measure in [[cent]]s of an interval [[ratio]], rounded to a precision of <code>prec</code> decimal places. Parameter <code>prec</code> defaults to 3 if it is omitted.
 * <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>