Module:Harmonic entropy/doc: Difference between revisions
m Improve description |
Added parse_ET_size and parse_ET_equave |
||
| Line 6: | Line 6: | ||
* <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>parse_ET(input)</code> returns the size (number of divisions) and the [[equave]] of an [[equal tuning]] given its name. Currently only supports equal divisions (e.g. no 88cET yet). This function is designed to be used by other modules only; it cannot be called with <code><nowiki>{{#invoke:}}</nowiki></code>. | * <code>parse_ET(input)</code> returns the size (number of divisions) and the [[equave]] of an [[equal tuning]] given its name. Currently only supports equal divisions (e.g. no 88cET yet). This function is designed to be used by other modules only; it cannot be called with <code><nowiki>{{#invoke:}}</nowiki></code>. | ||
* <code>parse_ET_size(frame)</code> and <code>parse_ET_equave</code> respectively return the size (number of divisions) and the equave of an [[equal tuning]] given its name. This function is designed to be used with <code><nowiki>{{#invoke:}}</nowiki></code> only. | |||
* <code>backslash_ratio(input)</code> returns the ratio corresponding to an interval written in [[backslash notation]]. | * <code>backslash_ratio(input)</code> returns the ratio corresponding to an interval written in [[backslash notation]]. | ||
<includeonly><hr><small>Documentation transcluded from [[/doc]]</small> [[Category:Lua modules]]</includeonly> | <includeonly><hr><small>Documentation transcluded from [[/doc]]</small> [[Category:Lua modules]]</includeonly> | ||