Module:ET/doc - Revision history

Ganaram inukshuk at 03:52, 31 October 2025

2025-10-31T03:52:04Z

← Older revision		Revision as of 03:52, 31 October 2025
Line 1:		Line 1:
	{{documentation\|		{{documentation\|{{dochead\|header=library}}
	{{dochead\|header=~~none~~}}
	This module provides helper functions for [[equal-step tuning]]s.		This module provides helper functions for [[equal-step tuning]]s.
	{{module introspection		{{module introspection

Ganaram inukshuk at 00:26, 28 October 2025

2025-10-28T00:26:50Z

← Older revision		Revision as of 00:26, 28 October 2025
Line 2:		Line 2:
	{{dochead\|header=none}}		{{dochead\|header=none}}
	This module provides helper functions for [[equal-step tuning]]s.		This module provides helper functions for [[equal-step tuning]]s.

	{{module introspection		{{module introspection
	\| desc_new = Returns an array consisting of the components of an equal-step tuning.		\| desc_new = Returns an array consisting of the components of an equal-step tuning.
Line 9:		Line 8:
	\| desc_backslash_ratio = Converts steps to a proper ratio as a floating-point number.		\| desc_backslash_ratio = Converts steps to a proper ratio as a floating-point number.
	\| desc_backslash_display = Displays an ET as steps\number-of-divisions.		\| desc_backslash_display = Displays an ET as steps\number-of-divisions.
	\| desc_cents = Converts an interval of the ET into cents.		\| desc_cents = Converts an interval of the ET into cents, {{c}}.
	\| desc_hekts = Converts an interval of the ET into hekts, the relative cents of 13edt.		\| desc_hekts = Converts an interval of the ET into hekts, the relative cents of 13edt.
	\| desc_approximate = Returns the floor, round, or ceiling of a particular ratio.		\| desc_approximate = Returns the floor, round, or ceiling of a particular ratio.

Ganaram inukshuk: transfer all function descriptions to module introspection; will need further formatting

2025-10-28T00:20:43Z

transfer all function descriptions to module introspection; will need further formatting

← Older revision		Revision as of 00:20, 28 October 2025
Line 3:		Line 3:
	This module provides helper functions for [[equal-step tuning]]s.		This module provides helper functions for [[equal-step tuning]]s.

	=~~== Functions ===~~		{{module introspection
	~~; <code>new</code>~~		\| desc_new = Returns an array consisting of the components of an equal-step tuning.
	: Returns an array consisting of the components of an equal-step tuning.		\| desc_parse = Converts an equal tuning as a string into a Lua table.
			\| desc_as_string = Returns the ET as a string.
	~~; <code>parse</code>~~		\| desc_backslash_ratio = Converts steps to a proper ratio as a floating-point number.
	~~: Designed to convert strings in the format <code>[number of steps]ed[equave]</code>~~ into ~~an ET structure, and returns it via the <code>new</code> function. For example, <code>ET~~.~~parse("12edo")</code> returns an array containing <code>{12, 2, "edo"}</code>~~		\| desc_backslash_display = Displays an ET as steps\number-of-divisions.
			\| desc_cents = Converts an interval of the ET into cents.
	~~; <code>as_string</code>~~		\| desc_hekts = Converts an interval of the ET into hekts, the relative cents of 13edt.
	: Returns the string ~~representation for an ET structure~~.		\| desc_approximate = Returns the floor, round, or ceiling of a particular ratio.
			\| desc_tempers_out = Determines whether an ET tempers out a provided rational number.
	~~; <code>backslash_ratio</code>~~		\| desc_is_highly_composite = Determines whether an ET is highly composite.
	: Converts steps to a proper ratio as a floating-point number.		\| desc_is_zeta = Determines if an ET holds any zeta records.
			\| desc_why_zeta = Describes what specific properties an ET has if it is a zeta record ET.
	~~; <code>backslash_display</code>~~		}}
	: Displays an ET ~~structure in backslash form (<code>[~~steps]\[number of divisions~~]</code>)~~.

	~~; <code>cents</code>~~
	: Converts the ~~interval an~~ ET ~~structure represents to [[cent]]s~~.

	~~; <code>hekts</code>~~
	: Converts the ~~interval an~~ ET ~~structure represents to [[hekt]]s ([[~~relative ~~cent]]~~ of [[13edt~~]])~~.

	~~; <code>approximate</code>~~
	: Returns the floor, round, or ceiling of a particular ratio.

	~~; <code>tempers_out</code>~~
	: Determines if an ET tempers out a provided rational number.

	~~; <code>is_highly_composite</code>~~
	: Determines if an ET is [[highly composite]].

	~~; <code>is_zeta</code>~~
	: Determines if an ET holds any ~~[[The Riemann zeta function and tuning\|~~zeta ~~record]]s~~.

	~~; <code>why_zeta</code>~~
	: Describes what specific properties an ET has if it is a zeta record ET.

	~~{{module introspection~~}}
	}}		}}

Ganaram inukshuk: drop lua template since introspection links to lua modules

2025-10-27T23:58:07Z

drop lua template since introspection links to lua modules

← Older revision		Revision as of 23:58, 27 October 2025
Line 1:		Line 1:
	{{documentation\|		{{documentation\|
	{{dochead\|header=none~~}}{{lua\|rational\|sequence~~}}		{{dochead\|header=none}}
	This module provides helper functions for [[equal-step tuning]]s.		This module provides helper functions for [[equal-step tuning]]s.

Ganaram inukshuk: add introspection

2025-10-27T22:28:12Z

add introspection

← Older revision		Revision as of 22:28, 27 October 2025
Line 39:		Line 39:
	; <code>why_zeta</code>		; <code>why_zeta</code>
	: Describes what specific properties an ET has if it is a zeta record ET.		: Describes what specific properties an ET has if it is a zeta record ET.

			{{module introspection}}
	}}		}}

ArrowHead294 at 12:03, 19 May 2025

2025-05-19T12:03:02Z

← Older revision		Revision as of 12:03, 19 May 2025
Line 1:		Line 1:
	{{documentation\|		{{documentation\|
	{{dochead\|header=none}}{{lua\|rational\|sequence}}		{{dochead\|header=none}}{{lua\|rational\|sequence}}
	~~<p>~~This module provides helper functions for [[equal-step tuning]]s.~~</p>~~		This module provides helper functions for [[equal-step tuning]]s.

	=== Functions ===		=== Functions ===

ArrowHead294 at 12:02, 19 May 2025

2025-05-19T12:02:47Z

← Older revision		Revision as of 12:02, 19 May 2025
Line 1:		Line 1:
	{{documentation\|		{{documentation\|
	{{dochead\|header=none}}		{{dochead\|header=none}}{{lua\|rational\|sequence}}
	This module provides helper functions for [[equal-step tuning]]s.		<p>This module provides helper functions for [[equal-step tuning]]s.</p>

	=== Functions ===		=== Functions ===

ArrowHead294 at 13:56, 5 March 2025

2025-03-05T13:56:04Z

← Older revision		Revision as of 13:56, 5 March 2025
Line 1:		Line 1:
	{{documentation\|{{dochead\|header=none}}		{{documentation\|
			{{dochead\|header=none}}
	This module provides helper functions for [[equal-step tuning]]s.		This module provides helper functions for [[equal-step tuning]]s.

ArrowHead294 at 13:19, 5 March 2025

2025-03-05T13:19:16Z

← Older revision		Revision as of 13:19, 5 March 2025
Line 7:		Line 7:

	; <code>parse</code>		; <code>parse</code>
	; Designed to convert strings in the format <code>[number of steps]ed[equave]</code> into an ET structure, and returns it via the <code>new</code> function. For example, <code>ET.parse("12edo")</code> returns an array containing <code>{12, 2, "edo"}</code>		: Designed to convert strings in the format <code>[number of steps]ed[equave]</code> into an ET structure, and returns it via the <code>new</code> function. For example, <code>ET.parse("12edo")</code> returns an array containing <code>{12, 2, "edo"}</code>

	; <code>as_string</code>		; <code>as_string</code>

FloraC: Fix a copying error

2025-03-05T11:46:23Z

Fix a copying error

← Older revision		Revision as of 11:46, 5 March 2025
Line 21:		Line 21:
	: Converts the interval an ET structure represents to [[cent]]s.		: Converts the interval an ET structure represents to [[cent]]s.

	; <code>~~cents~~</code>		; <code>hekts</code>
	: Converts the interval an ET structure represents to [[hekt]]s (~~where one ''hekt'' is 1/100 of one step~~ of ~~the~~ [[13edt~~\|Bohlen–Pierce scale~~]]).		: Converts the interval an ET structure represents to [[hekt]]s ([[relative cent]] of [[13edt]]).

	; <code>approximate</code>		; <code>approximate</code>