Xenharmonic Wiki

Module:Infobox ET: Difference between revisions

← Older edit
The situation is different for ed8's
Fredg999 (talk | contribs)
autopatrolled, Interface administrators, Sysops
6,129 edits
Make zeta properties display opt-in, but always include zeta categories nonetheless
 
(80 intermediate revisions by 6 users not shown)
Line 1: Line 1:
local p = {}
local p = {}
local i = require('Module:Interval')
 
local u = require('Module:Utils')
local ET = require("Module:ET")
local rat = require('Module:Rational')
local infobox = require("Module:Infobox")
local l = require('Module:Limits')
local limits = require("Module:Limits")
local ET = require('Module:ET')
local rat = require("Module:Rational")
local infobox = require('Module:Infobox')
local utils = require("Module:Utils")


-- check whether the input is a non-empty string
-- check whether the input is a non-empty string
local function value_provided(s)
local function value_provided(s)
return type(s) == 'string' and #s > 0
return type(s) == "string" and #s > 0
end
end


Line 15: Line 15:
local function approximation(et, interval, towards, precomputed_approx)
local function approximation(et, interval, towards, precomputed_approx)
local approx = precomputed_approx or ET.approximate(et, interval, towards or 0)
local approx = precomputed_approx or ET.approximate(et, interval, towards or 0)
 
-- string for backslash notation
-- "edo" is omitted
local tuning = et.size
local tuning = et.size
if not rat.eq(et.equave, 2) then
if not rat.eq(et.equave, 2) then
tuning = tuning .. et.suffix
tuning = tuning .. et.suffix
end
end
 
local ratio = rat.new(approx, et.size)
local ratio = rat.new(approx, et.size)
 
local convergement_notice = ''
-- convergence notice, suppressed for 1ed's
local convergement_notice = ""
local converges = rat.converges(ratio, math.log(interval) / math.log(rat.as_float(et.equave)))
local converges = rat.converges(ratio, math.log(interval) / math.log(rat.as_float(et.equave)))
if converges then
if et.size > 1 and converges then
convergement_notice = '<br/>(' .. converges .. ')'
convergement_notice = "<br>(" .. converges .. ")"
end
end
 
if rat.as_table(ratio)[1] ~= approx then
if rat.as_table(ratio)[1] ~= approx then
convergement_notice = ''
convergement_notice = ""
local link = rat.as_table(ratio)[2] .. et.suffix
local link = rat.as_table(ratio)[2] .. et.suffix
ratio = ' (→[[' .. link .. '|' .. rat.as_ratio(ratio, '\\')
ratio = string.format(" (&rarr;&nbsp;[[%s|%s%s]])",
if not rat.eq(et.equave, 2) then
link,
ratio = ratio .. et.suffix
rat.as_ratio(ratio, "\\"),
end
(rat.eq(et.equave, 2) == false and et.suffix or ""))
ratio = ratio .. ']])'
else
else
ratio = ''
ratio = ""
end
end
 
local cents = u._round(ET.cents(et, approx), 6)
local cents = utils._round(ET.cents(et, approx), 6)
 
return approx .. '\\' .. tuning .. ' (' .. cents .. '¢)' .. ratio .. convergement_notice
return approx .. "\\" .. tuning .. " (" .. cents .. "{{c}})" .. ratio .. convergement_notice
end
end


function p.infobox_ET(frame)
function p.infobox_ET(frame)
-- debug mode will disable the categories
-- debug mode will disable the categories
local debug_mode = frame.args['debug']
local debug_mode = frame.args["debug"]
local categories = ''
local categories = ""
 
local tuning = frame.args['tuning']
local tuning = frame.args["tuning"]
local et = ET.parse(tuning) or ET.parse('12edo')
local et = ET.parse(tuning) or ET.parse(tuning .. "edo") or ET.parse("12edo")
 
-- category of the main article
-- category of the main article
categories = categories .. '[[Category:' .. tuning .. '| ]]'
categories = categories .. "{{#ifexist: Category:" .. tuning .. "|[[Category:" .. tuning .. "| ]]|}}"
-- category of the equal division
-- category of the equal division
if rat.eq(et.equave, 2) then
if rat.eq(et.equave, 2) then
categories = categories .. '[[Category:Equal divisions of the octave|' .. string.rep ('#', string.len (et.size)) .. ']]'
categories = categories
.. "[[Category:Equal divisions of the octave|"
.. string.rep("#", string.len(et.size))
.. "]]"
elseif rat.eq(et.equave, 3) then
categories = categories .. "[[Category:Edts|" .. string.rep("#", string.len(et.size)) .. "]]"
elseif rat.eq(et.equave, rat.new (3, 2)) then
categories = categories .. "[[Category:Edfs|" .. string.rep("#", string.len(et.size)) .. "]]"
else
else
categories = categories .. '[[Category:' .. et.suffix .. '|' .. string.rep ('#', string.len (et.size)) .. ']]'
categories = categories .. "[[Category:" .. et.suffix .. "'s|" .. string.rep("#", string.len(et.size)) .. "]]"
end
end
 
-- prime test
-- prime factorization
local prime = ""
local prime_factorization_override = frame.args["Prime factorization"]
if u.is_prime(et.size) then
local prime_factorization
prime = " (prime)"
if not value_provided(prime_factorization_override) then
if rat.eq(et.equave, 2) then
prime_factorization = utils._prime_factorization(et.size)
categories = categories .. '[[Category:Prime EDO|' .. string.rep ('#', string.len (et.size)) .. ']]'
if utils.is_prime(et.size) then
prime_factorization = prime_factorization .. " (prime)"
if rat.eq(et.equave, 2) then
categories = categories .. "[[Category:Prime EDOs|" .. string.rep("#", string.len(et.size)) .. "]]"
end
end
end
else
prime_factorization = prime_factorization_override
end
end
 
-- zeta test
-- zeta test
local zeta_override = frame.args['Zeta']
local zeta_override = frame.args["Zeta"]
local zeta_switch = nil
local zeta_switch
if value_provided(zeta_override) then
if value_provided(zeta_override) then
zeta_switch = not zeta_override:match('^[Nn][Oo]$')
zeta_switch = zeta_override:match("^[Yy][Ee][Ss]$") and ET.is_zeta(et)
else
else
zeta_switch = rat.eq(et.equave, 2) and ET.is_zeta(et)
zeta_switch = false
end
end
 
local prev_one = ''
-- navigation arrows
if et.size > 0 then
local increment = 1
if rat.eq(et.equave, 9/4) or rat.eq(et.equave, 4) or rat.eq(et.equave, 9) then
if rat.eq(et.equave, rat.new(9, 4)) or rat.eq(et.equave, 4) or rat.eq(et.equave, 9) then
prev_one = '[[' .. (et.size - 2) .. et.suffix .. '|← ' .. (et.size - 2) .. et.suffix .. ']]'
increment = 2
else
prev_one = '[[' .. (et.size - 1) .. et.suffix .. '|← ' .. (et.size - 1) .. et.suffix .. ']]'
end
end
end
local next_one = '[[' .. (et.size + 1) .. et.suffix .. '|' .. (et.size + 1) .. et.suffix .. ' →]]'
local prev_one = ""
if rat.eq(et.equave, 9/4) or rat.eq(et.equave, 4) or rat.eq(et.equave, 9) then
if et.size >= increment then
next_one = '[[' .. (et.size + 2) .. et.suffix .. '| ' .. (et.size + 2) .. et.suffix .. '→]]'
prev_one = "[[" .. (et.size - increment) .. et.suffix .. "|&larr;&nbsp;" .. (et.size - increment) .. et.suffix .. "]]"
end
end
local next_one = "[[" .. (et.size + increment) .. et.suffix .. "|" .. (et.size + increment) .. et.suffix .. "&nbsp;&rarr;]]"
 
-- step size in cents
local step_size = ET.cents(et, 1)
local step_size = ET.cents(et, 1)
local note_12edo = ''
if step_size > 100 then
categories = categories .. "[[Category:Macrotonal|" .. string.rep("#", string.len(et.size)) .. "]]"
end
local note_12edo = ""
if rat.eq(et.equave, 2) and et.size == 12 then
if rat.eq(et.equave, 2) and et.size == 12 then
note_12edo = '<sup>by definition</sup>'
note_12edo = " (by&nbsp;definition)"
end
end
 
-- octave, twelfth, and fifth in steps
local octave = ET.approximate(et, 2)
local octave = ET.approximate(et, 2)
local twelfth = ET.approximate(et, 3)
local twelfth = ET.approximate(et, 3)
 
local fifth = -octave + twelfth -- 3/2 = [-1 1>
local fifth = -octave + twelfth -- 3/2 = [-1 1>
local fifth_error = ET.cents(et, fifth) - i._to_cents(3/2)
local fifth_error = ET.cents(et, fifth) - rat.cents(rat.new(3, 2))
local dual_fifth = math.abs(fifth_error) > step_size / 3
local is_dual_fifth = math.abs(fifth_error) > step_size / 3


local A1 = -11 * octave + 7 * twelfth -- 2187/2048 = [-11 7>
local A1 = -11 * octave + 7 * twelfth -- 2187/2048 = [-11 7>
local m2 = 8 * octave - 5 * twelfth -- 256/243 = [8 -5>
local m2 = 8 * octave - 5 * twelfth -- 256/243 = [8 -5>
local A1_cents = u._round(ET.cents(et, A1), 4)
local A1_cents = utils._round(ET.cents(et, A1), 4)
local m2_cents = u._round(ET.cents(et, m2), 4)
local m2_cents = utils._round(ET.cents(et, m2), 4)


-- display
local infobox_data = {}
local infobox_data = {}
table.insert(infobox_data, {
table.insert(infobox_data, {
'Prime factorization',
"Prime factorization",
u._prime_factorization(et.size) .. prime
prime_factorization,
})
})


table.insert(infobox_data, {
table.insert(infobox_data, {
'Step size',
"Step size",
u._round(step_size, 6) .. '¢' .. note_12edo
utils._round(step_size, 6) .. "{{c}}" .. note_12edo .. "&nbsp;",
})
})


if not rat.eq(et.equave, 2) then
if not rat.eq(et.equave, 2) then
table.insert(infobox_data, {
table.insert(infobox_data, {
'Octave',
"Octave",
approximation(et, 2)
approximation(et, 2),
})
})
end
if not rat.eq(et.equave, 3) then
table.insert(infobox_data, {
if not rat.eq(et.equave, rat.new(3, 2)) then
"Twelfth",
table.insert(infobox_data, {
approximation(et, 3),
'Fifth',
})
approximation(et, 3/2)
end
})
else
end
 
table.insert(infobox_data, {
'Semitones (A1:m2)',
A1 .. ':' .. m2 .. ' (' .. A1_cents .. '¢ : ' .. m2_cents .. '¢)'
})
 
if dual_fifth and et.size > 0 then
table.insert(infobox_data, {
table.insert(infobox_data, {
'Dual sharp fifth',
"Fifth",
approximation(et, 3/2, 1)
approximation(et, 3 / 2),
})
})
table.insert(infobox_data, {
table.insert(infobox_data, {
'Dual flat fifth',
"Semitones (A1:m2)",
approximation(et, 3/2, -1)
A1 .. ":" .. m2 .. " (" .. A1_cents .. "{{c}} : " .. m2_cents .. "{{c}})",
})
local sharp = ET.approximate(et, 3/2, 1)
local flat = ET.approximate(et, 3/2, -1)
table.insert(infobox_data, {
'Dual major 2nd',
approximation(et, 9/8, 0, sharp + flat - octave)
})
})
if is_dual_fifth and et.size > 0 then
table.insert(infobox_data, {
"Dual sharp fifth",
approximation(et, 3 / 2, 1),
})
table.insert(infobox_data, {
"Dual flat fifth",
approximation(et, 3 / 2, -1),
})
local sharp = ET.approximate(et, 3 / 2, 1)
local flat = ET.approximate(et, 3 / 2, -1)
table.insert(infobox_data, {
"Dual major 2nd",
approximation(et, 9 / 8, 0, sharp + flat - octave),
})
categories = categories
.. "[[Category:Dual-fifth temperaments|"
.. string.rep("#", string.len(et.size))
.. "]]"
end
end
end
 
local consistency = tonumber(frame.args['Consistency'])
-- consistency and distinct consistency
-- max_limit is used to prevent timeout
local consistency = tonumber(frame.args["Consistency"])
local max_limit = rat.eq(et.equave, 2) and 43 or 32
if consistency == nil then
if consistency == nil then
consistency = l.consistency_limit(et, false, 43)
consistency = limits.consistency_limit(et, false, max_limit)
end
end
if consistency == nil then
if consistency == nil then
consistency = 'at least 43'
consistency = "at least " .. max_limit
end
end
if consistency ~= nil then
if consistency ~= nil then
table.insert(infobox_data, {
table.insert(infobox_data, {
'Consistency limit',
"Consistency limit",
consistency
consistency,
})
})
end
end
local distinct_consistency = tonumber(frame.args['Distinct consistency'])
local distinct_consistency = tonumber(frame.args["Distinct consistency"])
if distinct_consistency == nil then
if distinct_consistency == nil then
distinct_consistency = l.consistency_limit(et, consistency or true, 43)
distinct_consistency = limits.consistency_limit(et, consistency or true, max_limit)
end
end
if distinct_consistency == nil then
if distinct_consistency == nil then
distinct_consistency = 'at least 43'
distinct_consistency = "at least " .. max_limit
end
end
if distinct_consistency ~= nil then
if distinct_consistency ~= nil then
table.insert(infobox_data, {
table.insert(infobox_data, {
'Distinct consistency limit',
"Distinct consistency limit",
distinct_consistency
distinct_consistency,
})
})
end
end


-- special properties
-- special properties
if ET.is_highly_composite(et) or zeta_switch then
if ET.is_highly_composite(et) or ET.is_zeta(et) then
local text = ''
local text = ""
if ET.is_highly_composite(et) then
if ET.is_highly_composite(et) then
text = text .. '[[Highly composite equal division|highly composite]]'
text = text .. "[[Highly composite equal division|Highly composite]]"
if rat.eq(et.equave, 2) then
if rat.eq(et.equave, 2) then
categories = categories .. '[[Category:Highly composite EDO|' .. string.rep ('#', string.len (et.size)) .. ']]'
categories = categories
.. "[[Category:Highly composite EDOs|"
.. string.rep("#", string.len(et.size))
.. "]]"
end
end
end
end
if zeta_switch then
if ET.is_zeta(et) and rat.eq(et.equave, 2) then
if #text > 0 then text = text .. '<br>' end
categories = categories
if not value_provided(zeta_override) then
.. "[[Category:Zeta record EDOs|"
.. string.rep("#", string.len(et.size))
.. "]]"
if zeta_switch then
if #text > 0 then
text = text .. "<br>"
end
text = text .. ET.why_zeta(et)
text = text .. ET.why_zeta(et)
else
text = text .. zeta_override
end
end
categories = categories .. '[[Category:Zeta|' .. string.rep ('#', string.len (et.size)) .. ']]'
end
if #text >0 then
table.insert(infobox_data, {
"Special properties",
"<div style=\"max-width: 300px;\">" .. text .. "</div>",
})
end
end
table.insert(infobox_data, {
'Special properties',
'<div style="max-width: 270px;">' .. text .. '</div>'
})
end
end


result = infobox.build(
local result = infobox.build("[[" .. et.suffix .. "|" .. tuning .. "]]", infobox_data, prev_one, next_one)
'[[' .. et.suffix .. '|' .. tuning .. ']]',
infobox_data,
prev_one,
next_one
)
if not value_provided(debug_mode) then
if not value_provided(debug_mode) then
result = result .. categories
result = result .. categories
end
end
return result
return frame:preprocess(result)
end
end


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