Struct NamedTemperament 

pub struct NamedTemperament {
    pub name: &'static str,
    pub page: &'static str,
    pub revision: u64,
    pub subgroup: &'static [IntegerType],
    pub periods_per_equave: UnsignedIntegerType,
    pub generator_rows: &'static [&'static [IntegerType]],
    pub generator_ratios: &'static [&'static str],
    pub generator_cents: &'static [FloatType],
    pub optimization: &'static str,
    pub titles: &'static str,
    pub commas: &'static [&'static str],
    pub moments: &'static [&'static str],
}

A regular temperament the Xenharmonic Wiki names and publishes a mapping for.

This is the published description; NamedTemperament::temperament turns it into a crate::tuningsystem::Temperament that can answer questions.

No Eq or Hash: a generator is a width in cents, and a float is not a thing to compare exactly or to key a map by.

Fields

name: &'static str

The name it goes by.

page: &'static str

The wiki page it was read from.

revision: u64

The revision of that page, so a later collection can diff.

subgroup: &'static [IntegerType]

The primes it is written over; the first is the equave.

periods_per_equave: UnsignedIntegerType

How many periods there are to an equave.

generator_rows: &'static [&'static [IntegerType]]

One row per generator, over the primes after the equave.

generator_ratios: &'static [&'static str]

Each generator written as the ratio it approximates.

generator_cents: &'static [FloatType]

Each generator’s width in cents, under optimization.

optimization: &'static str

Which optimum those widths are.

titles: &'static str

The infobox’s own Title, empty unless the page names more than one temperament.

The constant is named after the page, not after this: which of several names goes with which of the subgroups a page lists is not something the infobox states, so it is recorded here rather than guessed at.

commas: &'static [&'static str]

The commas it tempers out, as the wiki lists them.

moments: &'static [&'static str]

The moment-of-symmetry scales the wiki lists for it, if any.

Empty above rank 2: a moment of symmetry comes of stacking one generator, and a rank-3 temperament has two.

Implementations

impl NamedTemperament

pub fn temperament(&self) -> Result<Temperament>

Builds the temperament this entry describes.

Errors where Temperament::from_mapping_rows does, which for a collected entry means the wiki’s generators and its mapping disagree — a mistranscription, or a page that has changed under us.

impl NamedTemperament

pub const fn rank(&self) -> usize

How many rows the mapping has: one for the period, one per generator.

pub const fn equave(&self) -> IntegerType

The prime it repeats at — 2 for an octave, 3 for a tritave.

Trait Implementations

impl Clone for NamedTemperament

fn clone(&self) -> NamedTemperament

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for NamedTemperament

impl Debug for NamedTemperament

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for NamedTemperament

fn eq(&self, other: &NamedTemperament) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for NamedTemperament