Enum ToneValue

pub enum ToneValue {
    Cents(f64),
    Ratio(i64, i64),
}

Value of a tone.

The value of a tone is given either as a cents value or ratio.

Variants

Cents(f64)

Value of a tone given as cents value.

ToneValue::Cents(1200.0); // is an octave
ToneValue::Cents(700.0); // is an 12-EDO fifth

Ratio(i64, i64)

Value of a tone given as a ratio.

ToneValue::Ratio(2, 1); // is an octave as well
ToneValue::Ratio(3, 2); // is a JI fifth

Trait Implementations

impl Clone for ToneValue

fn clone(&self) -> ToneValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToneValue

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

Formats the value using the given formatter.

impl Default for ToneValue

fn default() -> Self

Returns the “default value” for a type.

impl Display for ToneValue

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

Formats the value using the given formatter.

impl Ord for ToneValue

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

impl PartialEq for ToneValue

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ToneValue

fn partial_cmp(&self, other: &Self) -> 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 Copy for ToneValue

impl Eq for ToneValue

impl StructuralPartialEq for ToneValue