Module:Chord consistency/doc: Difference between revisions

From Xenharmonic Wiki
Jump to navigation Jump to search
ArrowHead294 (talk | contribs)
mNo edit summary
Ganaram inukshuk (talk | contribs)
No edit summary
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{documentation|{{dochead|header=none}}
{{documentation|{{dochead|header=library}}
This module provides some functions which enumerate [[consistent]] equal divisions relative to some chord.
This module provides some functions which enumerate [[consistent]] equal divisions relative to some chord.


=== Functions ===
{{module introspection
; <code>additively_consistent_int</code>
| desc_additively_consistent_int=A variant of additively_consistent from Module:Limits that must be supplied with octave-reduced intervals.
: Slightly differ version of <code>[[Module:Limits]].additively_consistent</code>. That function must be supplied with octave-reduced intervals.
| desc_consistent_edos=Output list of consistent edos relative to given chord (Lua table of harmonics) up to 72edo. Different equaves, minimum consistency distance, maximum length of list are specifiable.
 
| desc_noinfobox_chord=Obsolete. Formerly used for Module:Infobox chord.}}
; <code>consistent_edos</code>
: Output list of consistent edos relative to given chord (Lua table of harmonics) up to 72edo. Different equaves, minimum consistency distance, maximum length of list are specifiable.
 
; <code>noinfobox_chord</code> (obsolete)
: A piece of code for [[Module: Infobox Chord]].


=== Format of edos list ===
=== Format of edos list ===
Output of <code>consistent_edos</code> are links to individual edos with each trailing several asterisks. These indicate consistency distace ''d'' briefly, none as {{nowrap|1 ≤ ''d'' < 2}}; * as {{nowrap|2 ≤ ''d'' < 4}}; ** as {{nowrap|4 ≤ ''d'' < 8}}; …}}
Output of <code>consistent_edos</code> are links to individual edos with each trailing several asterisks. These indicate consistency distace ''d'' briefly, none as {{nowrap|1 ≤ ''d'' < 2}}; * as {{nowrap|2 ≤ ''d'' < 4}}; ** as {{nowrap|4 ≤ ''d'' < 8}}; …}}

Latest revision as of 04:04, 31 October 2025

This module primarily serves as a library for other modules and has no corresponding template.

This module provides some functions which enumerate consistent equal divisions relative to some chord.

To see introspection summary, see this module's main page.

Format of edos list

Output of consistent_edos are links to individual edos with each trailing several asterisks. These indicate consistency distace d briefly, none as 1 ≤ d < 2; * as 2 ≤ d < 4; ** as 4 ≤ d < 8; …