Module:Chord consistency/doc: Difference between revisions

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


=== Functions ===
=== Functions ===
; <code>additively_consistent_int</code>
; <code>additively_consistent_int</code>
: Slightly differ version of [[Module:Limits]].additively_consistent. That function 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.


; <code>consistent_edos</code>
; <code>consistent_edos</code>
: Output list of consistent edos relative to given chord (Lua table of harmonics) up to 72edo. another EDs, minimum consistency distance, maximum length of list are specifiable.
: 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)
; <code>noinfobox_chord</code> (obsolete)
: A piece of code for [[Module:Infobox Chord]].
: 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 &le; ''d'' &lt; 2}}; * as {{nowrap|2 &le; ''d'' &lt; 4}}; ** as {{nowrap|4 &le; ''d'' &lt; 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}}; …}}
 
{{todo|inline=1| Documentation }}

Latest revision as of 23:15, 18 May 2025

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

Functions

additively_consistent_int
Slightly differ version of Module:Limits.additively_consistent. That function must be supplied with octave-reduced intervals.
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.
noinfobox_chord (obsolete)
A piece of code for Module: Infobox chord.

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; …