Enum Ratio 

pub enum Ratio {
    Rational {
        numerator: UnsignedIntegerType,
        denominator: UnsignedIntegerType,
    },
    Root {
        base: UnsignedIntegerType,
        numerator: UnsignedIntegerType,
        denominator: UnsignedIntegerType,
    },
}

An exact interval as a tuning table writes one: a ratio of whole numbers, or a root of one.

A root is how an equal division is exact: a step of twelve-tone equal temperament is 2^(1/12), and one of Bohlen-Pierce 3^(1/13). Neither is a fraction, which is why this is not a FractionType; a rational one converts to that with Ratio::to_fraction, and to a Monzo with Ratio::monzo.

Variants

Rational

numerator / denominator.

Fields

numerator: UnsignedIntegerType

The number on top.

denominator: UnsignedIntegerType

The number below.

Root

base^(numerator / denominator).

Fields

base: UnsignedIntegerType

The number a root is taken of.

numerator: UnsignedIntegerType

The power it is raised to.

denominator: UnsignedIntegerType

Which root is taken.

Implementations

impl Ratio

pub const fn new( numerator: UnsignedIntegerType, denominator: UnsignedIntegerType, ) -> Self

numerator / denominator.

pub const fn root( base: UnsignedIntegerType, numerator: UnsignedIntegerType, denominator: UnsignedIntegerType, ) -> Self

base^(numerator / denominator).

pub fn value(self) -> FloatType

How many times wider than a unison the interval is.

pub fn cents(self) -> FloatType

How wide the interval is, in cents.

pub fn to_fraction(self) -> Option<FractionType>

The ratio as a FractionType: None for a root, and for a ratio too wide for one.

pub fn monzo(self) -> Result<Monzo>

The ratio’s prime exponents. Errors on a root, whose exponents are not whole, and on a ratio with a prime past the ones Monzo carries.

pub fn with_octaves(self, octaves: UnsignedIntegerType) -> Self

The interval raised by octaves periods: octaves for a ratio, and whole powers of its base for a root.

Trait Implementations

impl Clone for Ratio

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Ratio

impl Debug for Ratio

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Ratio

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 Ratio

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

Formats the value using the given formatter.

impl Eq for Ratio

impl From<Ratio> for FloatType

fn from(ratio: Ratio) -> Self

Converts to this type from the input type.

impl PartialEq for Ratio

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Ratio

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 Ratio