Xenharmonic Wiki

Module:MOS modes: Difference between revisions

← Older edit
Ganaram inukshuk (talk | contribs)
autopatrolled, emailconfirmed
4,810 edits
No edit summary
ArrowHead294 (talk | contribs)
14,512 edits
mNo edit summary
 
(59 intermediate revisions by 4 users not shown)
Line 1: Line 1:
local mos = require('Module:MOS')
local rat = require('Module:Rational')
local p = {}
local p = {}


-- Function that takes a mos and produces all of the modes by brightness
local mos = require("Module:MOS")
-- The mos is entered as a data structure provided by Module:MOS
local rat = require("Module:Rational")
function p.modes_by_brightness(input_mos)
local tamnams = require("Module:TAMNAMS")
-- Default parameter, which corresponds to 5L 2s <2/1>
local tip = require("Module:Template input parse")
local input_mos = input_mos or mos.new(5, 2, 2)
local utils = require("Module:Utils")
local yesno = require("Module:Yesno")
-- Get the number of L's, s's, and periods
local nL = input_mos.nL
local ns = input_mos.ns
local periods = rat.gcd(nL, ns)
-- Find its brightest mode as a string of L's and s's
local brightest_mode = mos.brightest_mode(input_mos)
-- Find the size of the generator aned period in mossteps
local gen = mos.bright_gen(input_mos)
local gen_in_mossteps = gen['L'] + gen['s']
local period_size  = round((nL + ns) / periods)
-- For a mos xL ys, there are x+y unique modes that can be obtained by the following process:
-- For a generator g in mossteps (g < x+y) and starting with the brightest mode (as a string
-- of L's and s's), move the first g steps to the end to get the next-brightest mode.
-- Repeat this process with the rotated string to get all modes. The x+y-1th time this is done
-- will be the darkest mode.
-- In the case of a multiperiod mos nxL nys, consider it as the mos for xL ys and duplicate
-- each result n times. This way, the number of rotations needed to be performed is still x+y-1.
local brightest_mode_substr = string.sub(brightest_mode, 1, period_size)
local modes = { brightest_mode }
local current_mode = brightest_mode_substr
for i = 1, period_size - 1 do
-- Move the first g characters from the beginning to the end
local first_substr = string.sub(current_mode, 1, gen_in_mossteps)
local second_substr = string.sub(current_mode, gen_in_mossteps + 1, period_size)
current_mode = second_substr .. first_substr
-- Duplicate the string (just in case) then add it to the array of modes
local current_mode_duplicated = string.rep(current_mode, periods)
table.insert(modes, current_mode_duplicated)
end
return modes
end


-- Helper function that parses entries from a semicolon-delimited string and returns them in an array
-- TODO:
function p.parse_entries(unparsed)
-- - Add ability to autocollapse on large mos pages (say, more than 12 modes)
local parsed = {}
for entry in string.gmatch(unparsed, '([^;]+)') do
table.insert(parsed, entry) -- Add to array
end
return parsed
end


-- Test function that produces the modes of a mos as a table
-- "Main" function
-- TODO:
-- To be called by wrapper
-- - Allow for input of multiple sets of mode names, as some mosses have more than one set of names
function p._mos_modes(input_mos, mode_names, headers, entries, is_collapsed)
-- - Expand this (possibly as a separate template) for mos intervals
local is_collapsed = is_collapsed == true
function p.modes_table(frame)
local input_mos = input_mos or mos.new(5,2)
-- Mos is entered as a scale signature "xL ys" or "xL ys<p/q>" since the mos module can parse that format
local mode_names = mode_names or {}
local mosstring = frame.args['Scale Signature'] or "5L 2s"
local headers = headers or {}
local input_mos = mos.parse(mosstring)
local entries = entries or {}
-- Get the mos's mode names, if given
-- Get UDPs and CPOs
-- Mode names are entered as a semicolon-delimited list
local udps = tamnams.mos_mode_udps(input_mos)
local mode_names = nil
local cpos = tamnams.mos_mode_cpos(input_mos)
if mosstring == "5L 2s" then
mode_names_unparsed = "Lydian; Ionian (major); Mixolydian; Dorian; Aeolian (minor); Phrygian; Locrian"
mode_names = p.parse_entries(mode_names_unparsed)
else
mode_names_unparsed = frame.args['Mode Names']
mode_names = p.parse_entries(mode_names_unparsed)
end
-- Get the mos's modes and the mode count
-- Get the mos's modes
local mos_modes = p.modes_by_brightness(input_mos)
local mos_modes = mos.modes_by_brightness(input_mos)
local periods = rat.gcd(input_mos.nL, input_mos.ns) -- Needed for UDP


-- This is for entering multiple columns of info, if a single column of mode names isn't enough
-- Check whether to add mode names
-- For n headers, the number of entries must match the number of modes times the number of headers
local add_mode_names = #mode_names == #mos_modes
-- or else column data won't be added
local headers_unparsed = frame.args['Headers']
local headers = p.parse_entries(headers_unparsed)
local entries_unparsed = frame.args['Entries']
local entries = p.parse_entries(entries_unparsed)


-- To determine whether to add additional columns, determine whether the number of entries
-- Check whether the number of headers times the number of modes equals the
-- and the number of columns are greater than zero, and if so, determine whether the number of entries
-- number of entries. Supplementary info can only be added if this condition
-- is equal to the number of headers times the number of modes
-- is met. Limited to 3 columns of supplementary info.
local add_columns = #headers > 0 and #entries > 0
local add_columns = #headers > 0 and #entries > 0
if add_columns then
if add_columns then
add_columns = add_columns and #mos_modes * #headers == #entries
add_columns = add_columns and #mos_modes * #headers == #entries and #headers <= 3
end
end
-- Make a table with a column for the mode (as a string of L's and s's) and UDP
-- Table caption
local result = '{| class="wikitable"\n'
local scale_sig = mos.as_string(input_mos)
result = result .. "|+ " .. "Modes of " .. mosstring .. "\n"
result = result .. "|-\n"
result = result .. "! [[UDP]]\n"
result = result .. "! Step pattern\n"
-- If there are mode names (if the mode names array is not nil), then add a column for mode names
-- Start of table
if #mode_names == #mos_modes then
local result = "{| class=\"wikitable sortable center-2 center-3 mw-collapsible" .. (is_collapsed and " mw-collapsed\"\n" or "\"\n")
result = result .. "! Mode names\n"
.. "|+ style=\"font-size: 105%; white-space: nowrap;\" | " .. string.format("Modes of %s\n", scale_sig)
.. "|-\n"
-- Table headers
result = result
.. "! [[UDP]]"
.. " !! Cyclic<br />order"
.. " !! Step<br />pattern"
-- Add header for mode names, if provided.
if add_mode_names then
result = result .. " !! class=\"unsortable\" | Mode names"
end
end
-- Add columns
-- Add column headers for supplementary info, if provided.
-- If mode names and columns are used, mode names come first
if add_columns then
if add_columns then
for i = 1, #headers do
for i = 1, #headers do
result = result .. "! " .. headers[i] .. "\n"
result = result .. string.format(" !! class=\"unsortable\" | %s", headers[i])
end
end
end
end
result = result .. "\n"
-- Enter each row
-- Enter each row
-- As of coding, mos mode listings are fairly inconsistent or nonexistent, but consist of
-- the UDP, step pattern, and any mode names(s) in some order
-- This table orders them as UDP, step pattern, and (TODO) mode names, as that's more common
for i = 1, #mos_modes do
for i = 1, #mos_modes do
result = result .. "|-\n"
result = result .. "|-\n"
-- Add the UDP, formatted as up|dp, where u is the number of bright generators going up,
-- Add the UDP, brightness order, and the mode's step pattern
-- d is the number of bright generators going down, and p is the number of periods
result = result .. string.format("| %s || %s || %s",
-- (slightly different from standard UDP notation of up|dp(p))
udps[i], cpos[i], mos_modes[i])
local gens_down = (i - 1) * periods
local gens_up = (#mos_modes - i) * periods
result = result .. "|" .. gens_up .. '&#124;' .. gens_down .. "\n"
-- Add the mode's step pattern
result = result .. "|" .. mos_modes[i] .. "\n"
-- Add the mode's name, if given
-- Add the mode's name, if given
if #mode_names == #mos_modes then
if add_mode_names then
result = result .. "|" .. mode_names[i] .. "\n"
result = result .. string.format(" || %s", mode_names[i])
end
end
Line 142: Line 82:
if add_columns then
if add_columns then
for j = 1, #headers do
for j = 1, #headers do
result = result .. "|" .. entries[i + j - 1] .. "\n"
local index = (i - 1) * #headers + j
result = result .. string.format(" || %s", entries[index])
end
end
end
end
result = result .. "\n"
end
end
result = result .. "|}"
result = result .. "|}"
return result
end
-- Wrapper function; to be called by template
function p.modes_table(frame)
local scale_sig = frame.args["Scale Signature"] or "5L 2s"
local input_mos = mos.parse(scale_sig)
-- Get the mos's mode names, if given
-- Mode names are entered as a semicolon-delimited list
-- 5L 2s gets default names
local mode_names = nil
if scale_sig == "5L 2s" then
mode_names = {
"Lydian",
"Ionian (major)",
"Mixolydian",
"Dorian",
"Aeolian (minor)",
"Phrygian",
"Locrian"
}
end
-- Get mode names entered
if #frame.args["Mode Names"] ~= 0 then
mode_names = tip.parse_entries(frame.args["Mode Names"], "$")
end
-- Get supplementary info
local headers_unparsed = frame.args["Table Headers"]
local headers = tip.parse_entries(headers_unparsed, "$")
local entries_unparsed = frame.args["Table Entries"]
local entries = tip.parse_entries(entries_unparsed, "$")
local is_collapsed = yesno(frame.args["Collapsed"], false)
local debugg = yesno(frame.args["debug"])
local result = p._mos_modes(input_mos, mode_names, headers, entries, is_collapsed)
-- Current means of adding entries is unmaintainable; to be deprecated.
if headers_unparsed ~= "" and entries_unparsed ~= "" then
result = result .. "[[Category:Pages with deprecated template parameters]]"
end
return result
-- Debugger option
if debugg == true then
result = "<syntaxhighlight lang=\"wikitext\">" .. result .. "</syntaxhighlight>"
end
return frame:preprocess(result)
end
end


return p
return p
Retrieved from "https://en.xen.wiki/w/Module:MOS_modes"