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
Line 1: Line 1:
{{documentation|
{{documentation|{{dochead|header=none}}
{{dochead|header=none}}{{lua|ET|rational|utils}}
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>
: Slightly differ version of <code>[[Module:Limits]].additively_consistent</code>. That function must be supplied with octave-reduced intervals.
 
; <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}}; …}}

Revision as of 22:20, 30 October 2025

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