Module:JI ratios - Revision history

Ganaram inukshuk: comments

2025-10-23T09:21:19Z

comments

← Older revision		Revision as of 09:21, 23 October 2025
Line 1:		Line 1:
	~~local p = {}~~		-- This module follows [[User:Ganaram inukshuk/Provisional style guide for Lua]]

	local getArgs = require("Module:Arguments").getArgs		local getArgs = require("Module:Arguments").getArgs
	local med = require("Module:Mediants")		local med = require("Module:Mediants")
Line 7:		Line 6:
	local utils = require("Module:Utils")		local utils = require("Module:Utils")
	local yesno = require("Module:Yesno")		local yesno = require("Module:Yesno")

			local p = {}

			-- Template for handling multiple entry of JI ratios into a template, and for
			-- searching for JI ratios if automatic entry is desired.
			-- This is a successor/replacement for JI ratio finder.

	-- TODO: Refactor code such that:		-- TODO: Refactor code such that:
Line 35:		Line 40:

	-- TODO: write filter function for cent range		-- TODO: write filter function for cent range

	~~-- Template for handling multiple entry of JI ratios into a template, and for~~
	~~-- searching for JI ratios if automatic entry is desired.~~
	~~-- This is a successor/replacement for JI ratio finder.~~

	-- Module searches for ratios that are, at the minimum, up to an equave and are		-- Module searches for ratios that are, at the minimum, up to an equave and are

Ganaram inukshuk: todo; add odd-limit search

2025-10-08T23:55:34Z

todo; add odd-limit search

← Older revision		Revision as of 23:55, 8 October 2025
Line 7:		Line 7:
	local utils = require("Module:Utils")		local utils = require("Module:Utils")
	local yesno = require("Module:Yesno")		local yesno = require("Module:Yesno")

			-- TODO: Refactor code such that:
			-- - For int-limit search, int limit is the first arg, and equave and min/max
			-- cents default to 2/1, 0c, and 1200c respectively.
			-- (int_limit, equave)
			-- (int_limit, min_cents, max_cents)
			-- - For odd-limit search, odd limit is the first arg, int limit defaults to
			-- twice the odd limit, and equave and min/max cents default to 2/1, 0c, and
			-- 1200c respectively.
			-- (odd_limit, int_limit, equave)
			-- (odd_limit, int_limit, min_cents, max_cents)
			-- - For prime-limit search, prime-limit is the first arg, int limit defaults to
			-- twice the largest prime, and equave and min/max cents default to 2/1, 0c,
			-- and 1200c respectively.
			-- (prime_limit, int_limit, equave)
			-- (prime_limit, int_limit, min_cents, max_cents)
			-- - For subgroup search, subgroup is the first arg, there's no default value
			-- for int limit (due to complexity of subgroups), and equave and min/max
			-- cents default to 2/1, 0c, and 1200c respectively.
			-- (subgroup, int_limit, equave)
			-- (subgroup, int_limit, min_cents, max_cents)
			-- - Filter ratios function is split into two:
			-- - Filter ratios by complement removes ratios from a table if its complement
			-- is missing. Complements are octave-complements by default.
			-- - Filter ratios by tenney height removes ratios from a table if its tenney
			-- height exceeds a passed-in value.

	-- TODO: write filter function for cent range		-- TODO: write filter function for cent range
Line 16:		Line 42:
	-- Module searches for ratios that are, at the minimum, up to an equave and are		-- Module searches for ratios that are, at the minimum, up to an equave and are
	-- up to some integer limit. Search hierarchy is as follows:		-- up to some integer limit. Search hierarchy is as follows:
	-- - Search by subgroup (~~includes non-integer and~~ rational ~~elements~~)		-- - Search by subgroup (subgroup elements may be nonprime or rational)
	-- - Then search by prime limit		-- - Then search by prime limit
	-- - Then search by odd limit ~~(to be implemented)~~		-- - Then search by odd limit
	-- - Then search by int limit		-- - Then search by int limit

Line 138:		Line 164:
	--------------------------------------------------------------------------------		--------------------------------------------------------------------------------

	-- ~~to be implemented~~		-- Convert odd limit into equivalent subgroup.
			-- EG, 11-odd-limit becomes 2.3.5.7.9.11
			-- 2 is part of the subgroup by definition.
			function p.odd_limit_to_subgroup(odd_limit)
			local subgroup = { rat.new(2) }
			for i = 3, odd_limit, 2 do
			table.insert(subgroup, rat.new(i))
			end
			return subgroup
			end

			function p.search_by_odd_limit(equave, int_limit, odd_limit)
			local subgroup = p.odd_limit_to_subgroup(odd_limit)
			return p.search_by_subgroup_within_cents(0, rat.cents(equave), int_limit, subgroup)
			end

			function p.search_by_odd_limit_within_cents(min_cents, max_cents, odd_limit)
			local subgroup = p.odd_limit_to_subgroup(odd_limit)
			return p.search_by_subgroup_within_cents(min_cents, max_cents, int_limit, subgroup)
			end

	--------------------------------------------------------------------------------		--------------------------------------------------------------------------------
Line 144:		Line 189:
	--------------------------------------------------------------------------------		--------------------------------------------------------------------------------

			-- Convert prime limit into equivalent subgroup.
			-- EG, 11-prime-limit becomes 2.3.5.7.11
	function p.prime_limit_to_subgroup(prime_limit)		function p.prime_limit_to_subgroup(prime_limit)
	local subgroup = {}		local subgroup = {}
	for i = 2, prime_limit do		for i = 3, prime_limit do
	local is_prime = true		local is_prime = true
	for j = 2, math.floor(math.sqrt(i)) do		for j = 2, math.floor(math.sqrt(i)) do
Line 255:		Line 302:
	return ratios		return ratios
	end		end

			--------------------------------------------------------------------------------
			------------------------------- HELPER FUNCTIONS -------------------------------
			--------------------------------------------------------------------------------

	-- Heleper function; merges elements from source table with destination table		-- Heleper function; merges elements from source table with destination table
Line 357:		Line 408:
	function p._ji_ratios(args)		function p._ji_ratios(args)
	-- Args for ease of access		-- Args for ease of access
	equave = args["Equave"] or DEFAULT_EQUAVE		equave = args["Equave" ] or DEFAULT_EQUAVE
	int_limit = args["Int Limit"] or DEFAULT_INT_LIMIT		int_limit = args["Int Limit" ] or DEFAULT_INT_LIMIT
	odd_limit = args["Odd Limit"]		odd_limit = args["Odd Limit" ]
	prime_limit = args["Prime Limit"]		prime_limit = args["Prime Limit"]
	subgroup = args["Subgroup"]		subgroup = args["Subgroup" ]

	-- Filtering args		-- Filtering args
	tenney_height = args["Tenney Height"] or 1/0 -- Default Tenney height is infinity		tenney_height = args["Tenney Height" ] or 1/0 -- Default Tenney height is infinity
	complements_only = args["Complements Only"] or false -- Default is to include all ratios		complements_only = args["Complements Only"] or false -- Default is to include all ratios

Line 383:		Line 434:

	-- Invokable function; for templates		-- Invokable function; for templates
	-- Ratios are returned as a comma-delimited list, ~~for use with being displayed~~		-- Ratios are returned as a comma-delimited list. For finer control, it's
	-- ~~as a list~~.		-- necessary to call the "main" function, then further process the results.
	function p.ji_ratios(frame)		function p.ji_ratios(frame)
	args = getArgs(frame)		args = getArgs(frame)
Line 436:		Line 487:
	--return p.ratios_as_string(p._ji_ratios(p.parse_args("Int Limit: 16; Equave: 3/1; Complements Only: 0")))		--return p.ratios_as_string(p._ji_ratios(p.parse_args("Int Limit: 16; Equave: 3/1; Complements Only: 0")))
	--return p.ratios_as_string(p.search_by_prime_limit_within_cents(372, 440, 17, 30))		--return p.ratios_as_string(p.search_by_prime_limit_within_cents(372, 440, 17, 30))
	return p.ratios_as_string(p.~~search_by_int_limit_within_cents~~(~~380~~, ~~420~~, 50))		return p.ratios_as_string(p.search_by_odd_limit(rat.new(2), 15, 15*2))
	end		end

ArrowHead294 at 12:13, 1 June 2025

2025-06-01T12:13:36Z

← Older revision		Revision as of 12:13, 1 June 2025
Line 422:		Line 422:

	-- Find and return ratios		-- Find and return ratios
	~~ratios~~ = p._ji_ratios(args)		local result = p.ratios_as_string(p._ji_ratios(args))
	local debugg = yesno(frame.args["debug"])		local debugg = yesno(frame.args["debug"])
	~~local out_str = p.ratios_as_string(ratios)~~
	~~return frame:preprocess(~~debugg == true ~~and~~ "<~~pre~~>" .. ~~out_str~~ .. "</~~pre~~>" ~~or out_str~~)		if debugg == true then
			result = "<syntaxhighlight lang=\"wikitext\">" .. result .. "</syntaxhighlight>"
			end

			return frame:preprocess(result)

	end		end

ArrowHead294 at 12:44, 19 May 2025

2025-05-19T12:44:49Z

← Older revision		Revision as of 12:44, 19 May 2025
Line 1:		Line 1:
			local p = {}

			local getArgs = require("Module:Arguments").getArgs
			local med = require("Module:Mediants")
	local rat = require("Module:Rational")		local rat = require("Module:Rational")
			local tip = require("Module:Template input parse")
	local utils = require("Module:Utils")		local utils = require("Module:Utils")
	~~local tip = require("Module:Template input parse")~~
	~~local med = require("Module:Mediants")~~
	local yesno = require("Module:Yesno")		local yesno = require("Module:Yesno")
	~~local getArgs = require("Module:Arguments").getArgs~~
	~~p = {}~~

	-- TODO: write filter function for cent range		-- TODO: write filter function for cent range

Ganaram inukshuk: rewrite int-limit search to (hopefully) produce fewer out-of-range ratios

2025-03-20T07:48:22Z

rewrite int-limit search to (hopefully) produce fewer out-of-range ratios

← Older revision		Revision as of 07:48, 20 March 2025
Line 92:		Line 92:

	local init_ratios = {{1,1}, {1,0}}		local init_ratios = {{1,1}, {1,0}}
	local ratios = med.~~find_mediants_by_int_limit~~(init_ratios, int_limit)		local ratios = med.find_only_mediants(init_ratios, 2)
			for i = 3, int_limit do
	-- ~~Remove~~ last ratio ~~to prevent divide~~-by-~~zero~~		ratios = med.find_mediants_by_int_limit(ratios, i)
	table.remove(ratios, #ratios)
			-- Purge ratios from the beginning.
			-- If the first and second ratio are smaller than min_cents, and smaller
			-- than max_cents, then remove the first ratio. Keeping the first ratio
			-- would add mediants outside the cent range.
			local cents_1 = utils.log2(ratios[1][1] / ratios[1][2]) * 1200
			local cents_2 = utils.log2(ratios[2][1] / ratios[2][2]) * 1200
			if cents_1 < min_cents and cents_2 <= min_cents and cents_1 < max_cents and cents_2 < max_cents then
			table.remove(ratios, 1)
			end

			-- Purge ratios from the end.
			-- If the 2nd-last ratio and last ratio are greater than max_cents, and
			-- larger than min_cents, then remove the last ratio. Keeping the last
			-- ratio would add mediants outside the cent range.
			local cents_3 = utils.log2(ratios[#ratios-1][1] / ratios[#ratios-1][2]) * 1200
			local cents_4 = utils.log2(ratios[#ratios ][1] / ratios[#ratios ][2]) * 1200
			if cents_3 > max_cents and cents_4 >= max_cents and cents_3 > min_cents and cents_4 > min_cents then
			table.remove(ratios, #ratios)
			end
			end

	-- Convert to ratios that Module:Rational can work with		-- Convert to ratios that Module:Rational can work with
Line 102:		Line 122:
	end		end

	-- Remove ratios that fall outside the cent range.		-- Remove any remaining ratios that fall outside the cent range.
	while rat.cents(ratios[1]) < min_cents do		while rat.cents(ratios[1]) < min_cents do
	table.remove(ratios, 1)		table.remove(ratios, 1)
Line 410:		Line 430:
	--return p.ratios_as_string(p._ji_ratios(p.parse_args("Int Limit: 16; Equave: 3/1; Complements Only: 0")))		--return p.ratios_as_string(p._ji_ratios(p.parse_args("Int Limit: 16; Equave: 3/1; Complements Only: 0")))
	--return p.ratios_as_string(p.search_by_prime_limit_within_cents(372, 440, 17, 30))		--return p.ratios_as_string(p.search_by_prime_limit_within_cents(372, 440, 17, 30))
	return p.ratios_as_string(p.~~search_by_subgroup_within_cents~~(~~300~~,~~500~~, ~~30, {2,3,7}~~))		return p.ratios_as_string(p.search_by_int_limit_within_cents(380, 420, 50))
	end		end

Ganaram inukshuk: add todo to write filter-by-cent-range function

2025-03-18T22:45:53Z

add todo to write filter-by-cent-range function

← Older revision		Revision as of 22:45, 18 March 2025
Line 6:		Line 6:
	local getArgs = require("Module:Arguments").getArgs		local getArgs = require("Module:Arguments").getArgs
	p = {}		p = {}

			-- TODO: write filter function for cent range

	-- Template for handling multiple entry of JI ratios into a template, and for		-- Template for handling multiple entry of JI ratios into a template, and for
Line 38:		Line 40:
	-- - Removing ratios whose complement would exceed a max Tenney height or int limit		-- - Removing ratios whose complement would exceed a max Tenney height or int limit
	function p.filter_ratios(ratios, equave, int_limit, tenney_height, complements_only)		function p.filter_ratios(ratios, equave, int_limit, tenney_height, complements_only)
	~~--local tenney_height = tenney_height or 1/0 -- Default Tenney height is +infinity~~
	~~--local complements_only = complements_only or false -- Default is to allow ratios, regardless of whether their complement would be excluded~~

	local filtered_ratios = {}		local filtered_ratios = {}
Line 67:		Line 67:

	return filtered_ratios		return filtered_ratios
			end

			-- Filters ratios from a table of ratios, returning an array of ratios within
			-- the cent range and preserving the original table. Meant for searching for
			-- multiple ranges. TODO: write
			function p.filter_ratios_within_cent_range(ratios, min_cents, max_cents)

	end		end

Ganaram inukshuk at 20:17, 18 March 2025

2025-03-18T20:17:14Z

← Older revision		Revision as of 20:17, 18 March 2025
Line 160:		Line 160:
	function p.search_by_subgroup(equave, int_limit, subgroup)		function p.search_by_subgroup(equave, int_limit, subgroup)
	local ratios = p.search_by_subgroup_within_cents(0, rat.cents(equave), int_limit, subgroup)		local ratios = p.search_by_subgroup_within_cents(0, rat.cents(equave), int_limit, subgroup)
	~~while rat.cents(ratios[1]) < min_cents do~~
	~~table.remove(ratios, 1)~~
	~~end~~
	return ratios		return ratios
	end		end

Ganaram inukshuk at 20:16, 18 March 2025

2025-03-18T20:16:08Z

← Older revision		Revision as of 20:16, 18 March 2025
Line 96:		Line 96:

	-- Remove ratios that fall outside the cent range.		-- Remove ratios that fall outside the cent range.
	while rat.cents(ratios[1]) <= min_cents do		while rat.cents(ratios[1]) < min_cents do
	table.remove(ratios, 1)		table.remove(ratios, 1)
	end		end
	while rat.cents(ratios[#ratios]) >= max_cents do		while rat.cents(ratios[#ratios]) > max_cents do
	table.remove(ratios, #ratios)		table.remove(ratios, #ratios)
	end		end
Line 146:		Line 146:
	local subgroup = p.prime_limit_to_subgroup(prime_limit)		local subgroup = p.prime_limit_to_subgroup(prime_limit)
	local ratios = p.search_by_subgroup_within_cents(min_cents, max_cents, int_limit, subgroup)		local ratios = p.search_by_subgroup_within_cents(min_cents, max_cents, int_limit, subgroup)
	while rat.cents(ratios[1]) <= min_cents do		while rat.cents(ratios[1]) < min_cents do
	table.remove(ratios, 1)		table.remove(ratios, 1)
	end		end
Line 160:		Line 160:
	function p.search_by_subgroup(equave, int_limit, subgroup)		function p.search_by_subgroup(equave, int_limit, subgroup)
	local ratios = p.search_by_subgroup_within_cents(0, rat.cents(equave), int_limit, subgroup)		local ratios = p.search_by_subgroup_within_cents(0, rat.cents(equave), int_limit, subgroup)
	while rat.cents(ratios[1]) <= min_cents do		while rat.cents(ratios[1]) < min_cents do
	table.remove(ratios, 1)		table.remove(ratios, 1)
	end		end
Line 224:		Line 224:

	-- Remove ratios less than minimum		-- Remove ratios less than minimum
	while rat.cents(ratios[1]) <= min_cents do		while rat.cents(ratios[1]) < min_cents do
	table.remove(ratios, 1)		table.remove(ratios, 1)
	end		end
Line 406:		Line 406:
	--return p.ratios_as_string(p._ji_ratios(p.parse_args("Int Limit: 16; Equave: 3/1; Complements Only: 0")))		--return p.ratios_as_string(p._ji_ratios(p.parse_args("Int Limit: 16; Equave: 3/1; Complements Only: 0")))
	--return p.ratios_as_string(p.search_by_prime_limit_within_cents(372, 440, 17, 30))		--return p.ratios_as_string(p.search_by_prime_limit_within_cents(372, 440, 17, 30))
	return p.ratios_as_string(p.~~search_by_int_limit_within_cents~~(300,500, 20))		return p.ratios_as_string(p.search_by_subgroup_within_cents(300,500, 30, {2,3,7}))
	end		end

Ganaram inukshuk: cleanup; remove todo

2025-03-18T20:04:30Z

cleanup; remove todo

Show changes

Ganaram inukshuk: add search-within-cent-range functions; add todo to convert search-within-equave functions to use the search-within-cent-range functions, since code is near-identical

2025-03-18T08:09:16Z

add search-within-cent-range functions; add todo to convert search-within-equave functions to use the search-within-cent-range functions, since code is near-identical

Show changes