Struct Mos 

pub struct Mos { /* private fields */ }

How many large and small steps a moment of symmetry has.

This is the pattern with no tuning attached — 5L 2s is the diatonic scale whether its whole tone is 200 cents or 193, and 2L 5s is mavila’s anti-diatonic, where the pattern is the same shape but the two step sizes have traded places.

use music21_rs::tuningsystem::Mos;

let diatonic: Mos = "5L 2s".parse()?;
assert_eq!(diatonic.notes(), 7);
assert_eq!(diatonic.brightest_word(), "LLLsLLs");

Implementations

impl Mos

pub fn new( large: UnsignedIntegerType, small: UnsignedIntegerType, ) -> Result<Self>

Builds a pattern of large large steps and small small ones.

Errors when neither kind is present, since a scale with no steps at all is not a scale.

pub fn large(self) -> UnsignedIntegerType

How many large steps the pattern has.

pub fn small(self) -> UnsignedIntegerType

How many small steps the pattern has.

pub fn notes(self) -> UnsignedIntegerType

How many notes there are to a period, which is every step counted.

pub fn inverted(self) -> Self

The pattern with its two step sizes traded.

5L 2s is the diatonic scale and 2L 5s is mavila’s anti-diatonic: the same seven notes generated the same way, with the fifth flat enough that what was the large step became the small one.

pub fn brightest_word(self) -> String

The brightest mode’s step word, L for a large step and s for a small.

Brightest is the mode whose large steps come earliest, which for 5L 2s is Lydian — LLLsLLs, the diatonic scale from F with no accidentals.

Trait Implementations

impl Clone for Mos

fn clone(&self) -> Mos

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Mos

impl Debug for Mos

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Mos

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 Display for Mos

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

Writes the pattern the way the literature does, 5L 2s.

impl Eq for Mos

impl FromStr for Mos

fn from_str(text: &str) -> Result<Self>

Reads 5L 2s, with the space optional.

type Err = Error

The associated error which can be returned from parsing.

impl Hash for Mos

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Mos

fn cmp(&self, other: &Mos) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Mos

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Mos

fn partial_cmp(&self, other: &Mos) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Mos

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 Mos