Module:Harmonic entropy/doc: Difference between revisions

From Xenharmonic Wiki
Jump to navigation Jump to search
Fredg999 (talk | contribs)
m Update intro
Fredg999 (talk | contribs)
Fractions work now
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.
** ''Known issue: the ratio cannot be given as a fraction (e.g. 3/2); it must be given as a decimal number (e.g. 1.5).''


<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 18:16, 19 August 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 of prec decimal places. Parameter prec defaults to 3 if it is omitted.