Module:Infobox ET

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

Note: Do not invoke this module directly; use the corresponding template instead: Template:Infobox ET.

This module depends on the following other modules: Module: ET Module: Infobox Module: Limits Module: Rational Module: Utils

This module automatically fills in information about a specified equal temperament tuning.

---

local p = {}
local i = require('Module:Interval')
local u = require('Module:Utils')
local rat = require('Module:Rational')
local l = require('Module:Limits')

-- towards is one of: -1 (floor), 0 (nearest), 1 (ceil)
local function approximate(size, equave, interval, towards)
	towards = towards or 0
	local exact = math.log(interval) / math.log(rat.as_float(equave)) * size
	local approx = nil
	if towards < 0 then
		approx = math.floor(exact)
	elseif towards > 0 then
		approx = math.ceil(exact)
	else
		approx = math.floor(exact + 0.5)
	end
	return approx
end

-- towards is one of: -1 (floor), 0 (nearest), 1 (ceil)
local function approximation(tuning, size, equave, interval, towards)
	local approx = approximate(size, equave, interval, towards or 0)
	local ratio = rat.new(approx, size)
	if rat.as_table(ratio)[1] ~= approx then
		ratio = ' (→' .. rat.as_ratio(ratio, '\\') .. ')'
	else
		ratio = ''
	end
	return string.format("%d", approx) .. '\\' .. tuning
		.. ' (' .. i._to_cents(i._backslash_ratio(approx .. '\\' .. tuning), 6) .. '¢)'
		.. ratio
end

function p.infobox_ET(frame)
	local tuning = frame.args['tuning']
	local size, equave = i.parse_ET(tuning)
	local prime = ""
	if u.is_prime(size) then
		prime = " (prime)"
	end
	if rat.eq(equave, 2) then
		tuning = size
	end
	local step_size = i._backslash_ratio('1\\' .. tuning)
	local fifth_error = i._to_cents(i._backslash_ratio(approximate(size, equave, 3/2)) .. '\\' .. tuning) - i._to_cents(3/2)
	local dual_fifth = math.abs(fifth_error) > i._to_centes(step_size) / 3

	local infobox_data = {}
	table.insert(infobox_data, {
		'Prime factorization',
		u._prime_factorization(size) .. prime
	})
	table.insert(infobox_data, {
		'Step size',
		i._to_cents(step_size, 6) .. '¢'
	})
	table.insert(infobox_data, {
		'Fifth',
		approximation(tuning, size, equave, 3/2)
	})
	if dual_fifth then
		table.insert(infobox_data, {
			'Sharp fifth',
			approximation(tuning, size, equave, 3/2, 1)
		})
		table.insert(infobox_data, {
			'Flat fifth',
			approximation(tuning, size, equave, 3/2, -1)
		})
	end
	table.insert(infobox_data, {
		'Consistency limit',
		l.consistency_limit(size, equave)
	})
	table.insert(infobox_data, {
		'Distinct consistency limit',
		l.consistency_limit(size, equave, true)
	})

	local s = '<div style="\n' ..
		'border: 1px solid #999;\n' ..
		'margin: 0;\n' ..
		'margin-left: 1em;\n' ..
		'margin-bottom: 0.5em;\n' ..
		'padding: 0.5em;\n' ..
		'background-color: #f0f0f0;\n' ..
		'min-width: 15em;\n' ..
		'float: right;\n' ..
		'">\n' ..
		'{| width="100%" style="border-collapse: collapse;"\n' ..
		'|+ style="font-weight: bold" | ' .. frame.args['tuning'] .. '\n'
	for i, entry in ipairs(infobox_data) do
		local caption = entry[1]
		local text = entry[2]
		s = s .. '|-\n' ..
			'| style="text-align:right; padding-right: 0.25em" | ' .. caption .. '\n' ..
			'| style="background-color: white; padding-left: 0.25em; font-weight: bold" | ' .. text .. '\n'
	end
	s = s .. '|}</div>'
	return s
end

return p