Module:Harmonic entropy/doc: Difference between revisions
Jump to navigation
Jump to search
m Documentation update |
mNo edit summary |
||
| Line 5: | Line 5: | ||
== 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>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> | <includeonly><hr><small>Documentation transcluded from [[/doc]]</small> [[Category:Lua modules]]</includeonly> | ||
Revision as of 13:59, 10 October 2022
This module provides several functions to work with interval-related math.
Namely, the functions in this module can be called from other modules by using require('Module:Interval') and calling the _-prefixed functions.
Functions
to_cents(ratio, prec)returns the measure in cents of an interval ratio, rounded to a precision ofprecdecimal places. Parameterprecdefaults to 3 if it is omitted.harmonic_entropy(c, ratios, deviation, norm)computes harmonic Shannon entropy of an interval ofccents acrossratioswith a Gaussian with standarddeviation(also in cents) and anormassociated with theratios.