Module:Harmonic entropy/doc: Difference between revisions

(2 intermediate revisions by the same user not shown)

Line 1:

{{documentation|

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

=== 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>.

}}

@@ Line 1: / Line 1: @@
-{{dochead|header=none}}
+{{documentation|
-This module provides several functions to work with [[interval]]-related math. Currently, it only exists to calculate the harmonic entropy.
+{{dochead|header=none}}{{lua|Limits|Rational}}
+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 ==
+=== 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>.
+}}