Module:MOS intervals

Module documentation[view] [edit] [history] [purge]

This module should not be invoked directly; use its corresponding template instead: Template:MOS intervals.

This module generates a table showing interval varieties and qualities for a given MOS scale.

Introspection summary for Module:MOS intervals

Functions provided (2) Line Function Params 13 _mos_intervals (main) (input_mos, mos_prefix, mos_abbrev) 100 mos_intervals (invokable) (frame)

Lua modules required (6) Variable Module Functions used et Module:ET dependency not used mos Module:MOS new as_string mode_to_step_matrix brightest_mode darkest_mode equave_step_count period_step_count bright_gen_step_count dark_gen_step_count interval_eq interval_to_cents interval_as_string parse ord Module:Ordinal dependency not used rat Module:Rational dependency not used tamnams Module:TAMNAMS interval_quality lookup_prefix utils Module:Utils dependency not used

No function descriptions were provided. The Lua code may have further information.

---

local mos = require('Module:MOS')
local rat = require('Module:Rational')
local ord = require('Module:Ordinal')
local utils = require('Module:Utils')
local et = require('Module:ET')
local tamnams = require('Module:TAMNAMS')
local p = {}

-- TODO:
-- - Require both a mos prefix and abbrev

-- Main function; to be called by wrapper
function p._mos_intervals(input_mos, mos_prefix, mos_abbrev)
	-- Default param for input mos is 5L 2s
	local input_mos = input_mos or mos.new(5, 2, 2)
	local mos_prefix = mos_prefix or "mos"
	local mos_abbrev = mos_abbrev or "m"
	
	-- Get the scale sig
	local scale_sig = mos.as_string(input_mos)
	
	-- Get the brightest and darkest modes as step matrices
	local bright_step_matrix = mos.mode_to_step_matrix(mos.brightest_mode(input_mos))
	local dark_step_matrix = mos.mode_to_step_matrix(mos.darkest_mode(input_mos))
	
	-- Get the number of steps per period and equave
	local equave_step_count = mos.equave_step_count(input_mos)
	local period_step_count = mos.period_step_count(input_mos)
	
	-- Get the step counts for the bright and dark generators
	local bright_gen_step_count = mos.bright_gen_step_count(input_mos)
	local dark_gen_step_count = mos.dark_gen_step_count(input_mos)
	
	-- Create the table, starting with the headers
	local result = '{| class="wikitable"\n'
	result = result .. '|+ Intervals of ' .. scale_sig .. '\n'
	result = result .. '! colspan="3" | Intervals\n'
	result = result .. '! rowspan="2" | Steps subtended\n'
	result = result .. '! rowspan="2" | Range in cents\n'
	result = result .. '|-\n'
	result = result .. '! <abbr title="A mos interval denoted solely by the number of steps it subtends.">Generic</abbr>\n'
	result = result .. '! <abbr title="A mos interval denoted by the large and small steps it subtends.">Specific</abbr>\n'
	result = result .. '! <abbr title="The abbreviated form of the interval.>Abbrev.</abbr>\n'
	
	-- Write each row
	for i = 1, #bright_step_matrix do

		-- Compare the bright and dark intervals. If they're the same, then the
		-- current interval class is a period interval.
		local current_bright_interval = bright_step_matrix[i]
		local current_dark_interval = dark_step_matrix[i]
		local is_period = mos.interval_eq(current_bright_interval, current_dark_interval)
		
		-- If it's a period interval, then there is only one row to write.
		-- Otherwise, there are two rows to write, one for each size.
		if is_period then
			local cents = mos.interval_to_cents(current_bright_interval, input_mos, {1,1})
			
			result = result .. "|-\n"
			result = result .. string.format("| '''%s-%sstep'''\n", i-1, mos_prefix)
			result = result .. string.format("| %s\n" , tamnams.interval_quality(current_bright_interval, input_mos, "sentence-case"))
			result = result .. string.format("| %s\n" , tamnams.interval_quality(current_bright_interval, input_mos, "abbrev", "m"))
			result = result .. string.format("| %s\n" , mos.interval_as_string(current_bright_interval))
			result = result .. string.format("| %.1f¢\n", cents)
		else
			-- Calculate the cent values min and max for the current intervals
			local sm_min_cents = mos.interval_to_cents(current_dark_interval, input_mos, {1,1})
			local sm_max_cents = mos.interval_to_cents(current_dark_interval, input_mos, {1,0})
			local lg_min_cents = mos.interval_to_cents(current_bright_interval, input_mos, {1,1})
			local lg_max_cents = mos.interval_to_cents(current_bright_interval, input_mos, {1,0})
			
			-- Then sort, as the min and max may be swapped 
			-- This happens if the dark interval has more small steps than large steps
			local dark_interval_range   = string.format("%.1f¢ to %.1f¢", math.min(sm_min_cents, sm_max_cents), math.max(sm_min_cents, sm_max_cents))
			local bright_interval_range = string.format("%.1f¢ to %.1f¢", math.min(lg_min_cents, lg_max_cents), math.max(lg_min_cents, lg_max_cents))
			
			result = result .. "|-\n"
			result = result .. string.format("| rowspan=\"2\" | %s-%sstep\n", i-1, mos_prefix)
			result = result .. string.format("| %s\n" , tamnams.interval_quality(current_dark_interval, input_mos, "sentence-case"))
			result = result .. string.format("| %s\n" , tamnams.interval_quality(current_dark_interval, input_mos, "abbrev", "m"))
			result = result .. string.format("| %s\n" , mos.interval_as_string(current_dark_interval))
			result = result .. string.format("| %s\n" , dark_interval_range)
			
			result = result .. "|-\n"
			result = result .. string.format("| %s\n" , tamnams.interval_quality(current_bright_interval, input_mos, "sentence-case"))
			result = result .. string.format("| %s\n" , tamnams.interval_quality(current_bright_interval, input_mos, "abbrev", "m"))
			result = result .. string.format("| %s\n" , mos.interval_as_string(current_bright_interval))
			result = result .. string.format("| %s\n" , bright_interval_range)
		end

	end
	
	result = result .. "|}"	
	
	return result
	
end

-- Wrapper function; to be called by template
function p.mos_intervals(frame)
	-- Get input mos
	local input_mos = mos.parse(frame.args['Scale Signature'])
	
	-- Default param for mos prefix
	-- If "NONE" is given, no prefix will be used
	-- If left blank, try to find the appropriate mos prefix, or else defualt to "mos"
	-- If not left blank, use the prefix passed in instead
	local scale_sig = mos.as_string(input_mos)
	local mos_prefix = tamnams.lookup_prefix(input_mos)
	if frame.args['MOS Prefix'] == "NONE" then
		mos_prefix = ""
	elseif string.len(frame.args['MOS Prefix']) > 0 then
		mos_prefix = frame.args['MOS Prefix']
	end

	local result = p._mos_intervals(input_mos, mos_prefix)

	return result
end

return p