Struct MosScale 

pub struct MosScale { /* private fields */ }

A generator and a period, folded into a scale of so many notes.

The generator and period are cents, so nothing here assumes an octave: Bohlen-Pierce generates inside a period of 1901.955 cents and works the same way.

use music21_rs::tuningsystem::{MosScale, OCTAVE_CENTS};

// Seven fifths folded into an octave are the diatonic scale. Stacked
// upwards from the tonic they land in its brightest mode, Lydian.
let diatonic = MosScale::new(701.955, OCTAVE_CENTS, 7)?;
assert_eq!(diatonic.pattern()?.to_string(), "5L 2s");
assert_eq!(diatonic.word()?, "LLLsLLs");

Implementations

impl MosScale

pub fn new( generator: FloatType, period: FloatType, notes: UnsignedIntegerType, ) -> Result<Self>

Builds a scale of notes notes from a generator inside a period.

The generator is folded into the period, so handing over a fifth of 701.955 and a fifth of 1901.955 build the same scale. Errors on a period that is not positive, on a generator that folds to nothing, and on a scale of no notes.

pub fn from_equal_division( steps: UnsignedIntegerType, divisions: UnsignedIntegerType, period: FloatType, notes: UnsignedIntegerType, ) -> Result<Self>

Builds a scale whose generator is steps of an equal division.

This is the wiki’s 3\22 — three steps of 22 equal divisions of the period — which is how a generator is usually named once a temperament has been pinned to an equal temperament that supports it.

pub fn generator(self) -> FloatType

The generator, in cents, folded into the period.

pub fn period(self) -> FloatType

The period, in cents.

pub fn notes(self) -> UnsignedIntegerType

How many notes there are to a period.

pub fn degrees(self) -> Vec<FloatType>

The scale’s degrees in cents, rising from nought inside one period.

pub fn steps(self) -> Vec<FloatType>

The width of each step in cents, from the tonic round to the period.

pub fn is_moment_of_symmetry(self) -> bool

Whether the scale really is a moment of symmetry — two step sizes, no more.

pub fn is_equal(self) -> bool

Whether every step came out the same width, which is an equal division.

pub fn pattern(self) -> Result<Mos>

How many large and small steps the scale has.

Errors when the scale is not a moment of symmetry at all: either every step is the same width, which is an equal division, or there are three widths or more, which is the note count between two moments.

pub fn word(self) -> Result<String>

The scale’s own step word, from its tonic rather than from its brightest mode.

Errors where MosScale::pattern does.

Trait Implementations

impl Clone for MosScale

fn clone(&self) -> MosScale

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MosScale

impl Debug for MosScale

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MosScale

Available on crate feature serde only.

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for MosScale

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for MosScale

Available on crate feature serde only.

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MosScale