Module:ET/doc

This template has been deprecated. Its replacements are Template:Dochead and Template:Module introspection.

This module depends on the following other modules: Module: Rational Module: Sequence

This module provides helper functions for equal-step tunings.

Functions

new

Returns an array consisting of the components of an equal-step tuning.

parse

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

as_string

Returns the string representation for an ET structure.

backslash_ratio

Converts steps to a proper ratio as a floating-point number.

backslash_display

Displays an ET structure in backslash form ([steps]\[number of divisions]).

cents

Converts the interval an ET structure represents to cents.

hekts

Converts the interval an ET structure represents to hekts (relative cent of 13edt).

approximate

Returns the floor, round, or ceiling of a particular ratio.

tempers_out

Determines if an ET tempers out a provided rational number.

is_highly_composite

Determines if an ET is highly composite.

is_zeta

Determines if an ET holds any zeta records.

why_zeta

Describes what specific properties an ET has if it is a zeta record ET.