Struct Monzo 

pub struct Monzo { /* private fields */ }

An interval written as the exponents of the primes making up its ratio.

The entries are positional over PRIMES, so [-4 4 -1⟩ is 2^-4 * 3^4 * 5^-1, the syntonic comma. Multiplying two intervals adds their monzos, which is the whole reason for writing intervals this way.

use music21_rs::tuningsystem::Monzo;

let comma = Monzo::from_ratio(81, 80)?;
assert_eq!(comma.exponents(), [-4, 4, -1]);
assert_eq!(comma.limit(), Some(5));
assert_eq!(comma.to_string(), "[-4 4 -1⟩");

Implementations

impl Monzo

pub fn new(exponents: impl Into<Vec<IntegerType>>) -> Self

Builds a monzo from prime exponents, lowest prime first.

pub fn unison() -> Self

The unison, whose every exponent is nought.

pub fn from_ratio( numerator: IntegerType, denominator: IntegerType, ) -> Result<Self>

Factors a ratio into prime exponents.

Errors on a ratio that is not positive, or one carrying a prime factor larger than PRIMES reaches.

pub fn from_fraction(ratio: FractionType) -> Result<Self>

Factors a FractionType into prime exponents.

pub fn exponents(&self) -> &[IntegerType]

The prime exponents, lowest prime first, without trailing zeros.

pub fn exponent_of(&self, prime: IntegerType) -> Result<IntegerType>

The exponent of prime, which is nought for a prime not written.

Errors only for a number that is not a prime this module carries.

pub fn limit(&self) -> Option<IntegerType>

The largest prime the monzo actually uses, or None for the unison.

pub fn is_unison(&self) -> bool

Whether every exponent is nought.

pub fn ratio(&self) -> Result<FractionType>

The ratio the exponents multiply out to.

Errors when the ratio does not fit an IntegerType, which a stack of any size will reach — [-4 4 -1⟩ is 81/80, but twelve of them are not a fraction of two i32s.

pub fn cents(&self) -> FloatType

How wide the interval is, in cents.

pub fn multiply(&self, other: &Self) -> Self

The interval reached by sounding both, which adds the exponents.

pub fn divide(&self, other: &Self) -> Self

The interval left by taking other off this one.

pub fn inverse(&self) -> Self

The same interval measured the other way.

pub fn pow(&self, count: IntegerType) -> Self

The interval stacked count times.

Trait Implementations

impl Clone for Monzo

fn clone(&self) -> Monzo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Monzo

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

Formats the value using the given formatter.

impl Default for Monzo

fn default() -> Monzo

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Monzo

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 Monzo

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

Writes the monzo in the wiki’s own notation, [-4 4 -1⟩.

impl Eq for Monzo

impl FromStr for Monzo

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

Reads [-4 4 -1⟩, and the ASCII spelling |-4 4 -1> beside it.

type Err = Error

The associated error which can be returned from parsing.

impl Hash for Monzo

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 Monzo

fn cmp(&self, other: &Monzo) -> 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 Monzo

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Monzo

fn partial_cmp(&self, other: &Monzo) -> 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 Monzo

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 Monzo