|
|
| (5 intermediate revisions by 2 users not shown) |
| Line 1: |
Line 1: |
| {{documentation| | | {{documentation|{{dochead|header=library}} |
| {{dochead|header=none}}{{lua|rational|sequence}} | | This module provides helper functions for [[equal-step tuning]]s. |
| <p>This module provides helper functions for [[equal-step tuning]]s.</p>
| | {{module introspection |
| | | | desc_new = Returns an array consisting of the components of an equal-step tuning. |
| === Functions === | | | desc_parse = Converts an equal tuning as a string into a Lua table. |
| ; <code>new</code>
| | | desc_as_string = Returns the ET as a string. |
| : Returns an array consisting of the components of an equal-step tuning.
| | | desc_backslash_ratio = Converts steps to a proper ratio as a floating-point number. |
| | | | desc_backslash_display = Displays an ET as steps\number-of-divisions. |
| ; <code>parse</code>
| | | desc_cents = Converts an interval of the ET into cents, {{c}}. |
| : 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>
| | | desc_hekts = Converts an interval of the ET into hekts, the relative cents of 13edt. |
| | | | desc_approximate = Returns the floor, round, or ceiling of a particular ratio. |
| ; <code>as_string</code>
| | | desc_tempers_out = Determines whether an ET tempers out a provided rational number. |
| : Returns the string representation for an ET structure.
| | | desc_is_highly_composite = Determines whether an ET is highly composite. |
| | | | desc_is_zeta = Determines if an ET holds any zeta records. |
| ; <code>backslash_ratio</code>
| | | desc_why_zeta = Describes what specific properties an ET has if it is a zeta record ET. |
| : 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>hekts</code>
| |
| : Converts the interval an ET structure represents to [[hekt]]s ([[relative cent]] of [[13edt]]).
| |
| | |
| ; <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.
| |
| }} | | }} |