Module:Harmonic entropy/doc: Difference between revisions

Ganaram inukshuk (talk | contribs)
No edit summary
Ganaram inukshuk (talk | contribs)
put back function descriptions
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{documentation|
{{documentation|{{dochead|header=library}}
{{dochead|header=library}
This module provides a means to calculate harmonic Shannon entropy of a particular interval.  
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.
{{module introspection
 
| desc_harmonic_entropy=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>.}}
{{module introspection}}
}}
}}