Module:JI ratios: Difference between revisions

Line 15:

-- This is a successor/replacement for JI ratio finder.

-- JI ratios are ~~searched by~~ the ~~following params in a hierarchy:~~

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

-- ~~- Search by prime~~ limit. ~~Int limit~~ is ~~used to limit the num/den of ratios.~~

-- up to some integer limit. Search hierarchy is as follows:

-- ~~Prime limit takes precedence over~~ subgroup.

-- - Search by subgroup (includes non-integer and rational elements)

-- - ~~Search~~ by ~~subgroup. (Subgroup may contain nonprime numbers, but ratios are~~

-- - Then search by prime limit

-- ~~currently not supported.) Int~~ limit ~~is used~~ to ~~limit the num/den of ratios.~~

-- - Then search by odd limit (to be implemented)

-- - ~~If neither prime limit or subgroup is present,~~ search by int limit~~. This~~

-- - Then search by int limit

-- ~~is considered the absolute minimum requirement for ratio searching.~~

-- ~~NOTES~~:

-- Optional args omit ratios that don't meet certain conditions, and are used

-- - ~~Prime limits are infinite sets, so int limit is used to restrain the set~~

-- to further limit the number of ratios found. Current options include:

-- ~~to a finite size. The same~~ is ~~true for subgroup~~.

-- - Tenney Height: omits ratios that exceed some max Tenney height. Has no

-- - ~~Tenney height is used for further filtering of~~ ratios, and ~~is considered~~

-- effect if no Tenney height is passed in.

-- ~~optional. If~~ omitted, ~~tenney~~ height ~~defaults to infinity~~.

-- - Complements Only: omits ratios and their equave complements if either would

-- be omitted by Tenney height, or if no Tenney height is entered, omits

-- ratios whose complements are missing.

--------------------------------------------------------------------------------

Line 261:

Line 263:

-- Function callable by other modules

-- ~~Search hierarchy is~~ as ~~follows:~~

-- Ratios are returned as a table, for use with other modules

~~-- - Search by subgroup (includes non-integer and rational elements)~~

~~-- - Then search by prime limit~~

~~-- - Then search by odd limit (to be implemented)~~

~~-- - Then search by int limit~~

function p._ji_ratios(args)

-- Args for ease of access

@@ Line 15: / Line 15: @@
 -- This is a successor/replacement for JI ratio finder.
--- JI ratios are searched by the following params in a hierarchy:
+-- Module searches for ratios that are, at the minimum, up to an equave and are
--- - Search by prime limit. Int limit is used to limit the num/den of ratios.
+-- up to some integer limit. Search hierarchy is as follows:
---   Prime limit takes precedence over subgroup.
+-- - Search by subgroup (includes non-integer and rational elements)
--- - Search by subgroup. (Subgroup may contain nonprime numbers, but ratios are
+-- - Then search by prime limit
---   currently not supported.) Int limit is used to limit the num/den of ratios.
+-- - Then search by odd limit (to be implemented)
--- - If neither prime limit or subgroup is present, search by int limit. This
+-- - Then search by int limit
---   is considered the absolute minimum requirement for ratio searching.
--- NOTES:
+-- Optional args omit ratios that don't meet certain conditions, and are used
--- - Prime limits are infinite sets, so int limit is used to restrain the set
+-- to further limit the number of ratios found. Current options include:
---   to a finite size. The same is true for subgroup.
+-- - Tenney Height: omits ratios that exceed some max Tenney height. Has no
--- - Tenney height is used for further filtering of ratios, and is considered
+--   effect if no Tenney height is passed in.
---   optional. If omitted, tenney height defaults to infinity.
+-- - Complements Only: omits ratios and their equave complements if either would
+--   be omitted by Tenney height, or if no Tenney height is entered, omits
+--   ratios whose complements are missing.
 --------------------------------------------------------------------------------
@@ Line 261: / Line 263: @@
 -- Function callable by other modules
--- Search hierarchy is as follows:
+-- Ratios are returned as a table, for use with other modules
--- - Search by subgroup (includes non-integer and rational elements)
--- - Then search by prime limit
--- - Then search by odd limit (to be implemented)
--- - Then search by int limit
 function p._ji_ratios(args)
 	-- Args for ease of access