Template:Uniform map/doc: Difference between revisions

From Xenharmonic Wiki
Jump to navigation Jump to search
Sintel (talk | contribs)
fix docs
Sintel (talk | contribs)
update docs
Line 3: Line 3:


=== Usage ===
=== Usage ===
This template accepts three arguments:
This template accepts the following named arguments:
# Prime limit (write only the prime number); defaults to 5-limit.
# <code>edo</code>: The central EDO for the range.
# Minimum size, given as 1\size (write only the decimal number); defaults to 11.5.
# <code>min</code>: Minimum size, given as 1\size (write only the decimal number).
# Maximum size, given as 1\size (write only the decimal number); defaults to 12.5.
# <code>max</code>: Maximum size, given as 1\size (write only the decimal number).
# <code>limit</code>: Prime limit (write only the prime number); defaults to 13-limit.


==== Example ====
If no min/max are provided, the range wil be <code>edo</code> +/- 0.2 (see first example below).
For example:


<pre>{{Uniform map|7|16.5|17.5}}</pre>
==== Examples ====
Preferably, stick to just providing the EDO for the page:
<pre>{{Uniform map|edo=7}}</pre>


gives:
gives:
{{Uniform map|7|16.5|17.5}}
{{Uniform map|edo=7}}
 
You can customize the table by providing more arguments:
<pre>{{Uniform map|min=6.5|max=7.5|limit=5}}</pre>
 
gives:
{{Uniform map|min=6.5|max=7.5|limit=5}}

Revision as of 17:20, 29 March 2025

This template is implemented by the Lua module Module:Uniform map.
This template invokes the following functions: print_table from Uniform map.

The Uniform map templates creates a table of p-limit uniform maps between two size boundaries.

Usage

This template accepts the following named arguments:

  1. edo: The central EDO for the range.
  2. min: Minimum size, given as 1\size (write only the decimal number).
  3. max: Maximum size, given as 1\size (write only the decimal number).
  4. limit: Prime limit (write only the prime number); defaults to 13-limit.

If no min/max are provided, the range wil be edo +/- 0.2 (see first example below).

Examples

Preferably, stick to just providing the EDO for the page:

{{Uniform map|edo=7}}

gives:

13-limit uniform maps between 6.8 and 7.2
Min. size Max. size Wart notation Map
6.7930 6.8911 7df 7 11 16 19 24 25]
6.8911 6.9460 7d 7 11 16 19 24 26]
6.9460 7.0821 7 7 11 16 20 24 26]
7.0821 7.1062 7e 7 11 16 20 25 26]
7.1062 7.1613 7ce 7 11 17 20 25 26]
7.1613 7.2557 7ceff 7 11 17 20 25 27]

You can customize the table by providing more arguments:

{{Uniform map|min=6.5|max=7.5|limit=5}}

gives:

5-limit uniform maps between 6.5 and 7.5
Min. size Max. size Wart notation Map
6.5000 6.6248 7bbcc 7 10 15]
6.6248 6.6755 7cc 7 11 15]
6.6755 7.1062 7 7 11 16]
7.1062 7.2557 7c 7 11 17]
7.2557 7.5000 7bc 7 12 17]