Module:ET/doc: Difference between revisions
Jump to navigation
Jump to search
ArrowHead294 (talk | contribs) mNo edit summary |
ArrowHead294 (talk | contribs) m Fill in documentation |
||
| Line 1: | Line 1: | ||
{{ | {{documentation|{{dochead|header=none}} | ||
{ | This module provides helper functions for [[equal-step tuning]]s. | ||
=== Functions === | |||
; <code>new</code> | |||
: Returns an array consisting of the components of an equal-step tuning. | |||
; <code>parse</code> | |||
; Designed to convert strings in the format <code>[number of steps]ed[equave]</code> into an ET structure, and returns it via the <code>new</code> function. For example, <code>ET.parse("12edo")</code> returns an array containing <code>{12, 2, "edo"}</code> | |||
; <code>as_string</code> | |||
: Returns the string representation for an ET structure. | |||
; <code>backslash_ratio</code> | |||
: Converts steps to a proper ratio as a floating-point number. | |||
; <code>backslash_display</code> | |||
: Displays an ET structure in backslash form (<code>[steps]\[number of divisions]</code>). | |||
; <code>cents</code> | |||
: Converts the interval an ET structure represents to [[cent]]s. | |||
; <code>cents</code> | |||
: Converts the interval an ET structure represents to [[hekt]]s (where one ''hekt'' is 1/100 of one step of the [[13edt|Bohlen–Pierce scale]]). | |||
; <code>approximate</code> | |||
: Returns the floor, round, or ceiling of a particular ratio. | |||
; <code>tempers_out</code> | |||
: Determines if an ET tempers out a provided rational number. | |||
; <code>is_highly_composite</code> | |||
: Determines if an ET is [[highly composite]]. | |||
; <code>is_zeta</code> | |||
: Determines if an ET holds any [[The Riemann zeta function and tuning|zeta record]]s. | |||
; <code>why_zeta</code> | |||
: Describes what specific properties an ET has if it is a zeta record ET. | |||
}} | |||
Revision as of 14:41, 25 January 2025
This module provides helper functions for equal-step tunings.
Functions
new- Returns an array consisting of the components of an equal-step tuning.
parse- Designed to convert strings in the format
[number of steps]ed[equave]into an ET structure, and returns it via thenewfunction. For example,ET.parse("12edo")returns an array containing{12, 2, "edo"}
as_string- Returns the string representation for an ET structure.
backslash_ratio- Converts steps to a proper ratio as a floating-point number.
backslash_display- Displays an ET structure in backslash form (
[steps]\[number of divisions]).
cents- Converts the interval an ET structure represents to cents.
cents- Converts the interval an ET structure represents to hekts (where one hekt is 1/100 of one step of the Bohlen–Pierce scale).
approximate- Returns the floor, round, or ceiling of a particular ratio.
tempers_out- Determines if an ET tempers out a provided rational number.
is_highly_composite- Determines if an ET is highly composite.
is_zeta- Determines if an ET holds any zeta records.
why_zeta- Describes what specific properties an ET has if it is a zeta record ET.