Enum tonality::interval::Interval

pub enum Interval {
    Dim2,
    Dim6,
    Dim3,
    Dim7,
    Dim4,
    Dim1,
    Dim5,
    Min2,
    Min6,
    Min3,
    Min7,
    P4,
    Unison,
    P5,
    Maj2,
    Maj6,
    Maj3,
    Maj7,
    Aug4,
    Aug1,
    Aug5,
    Aug2,
    Aug6,
    Aug3,
    Aug7,
}

An interval relates two tonal pitch classes to each other. Note: Intervals are ordered by distance on the line of fifth, not by the number of semitones.

assert!(Interval::P5 < Interval::Aug4);

Variants

Dim2

Dim6

Dim3

Dim7

Dim4

Dim1

Dim5

Min2

Min6

Min3

Min7

P4

Unison

P5

Maj2

Maj6

Maj3

Maj7

Aug4

Aug1

Aug5

Aug2

Aug6

Aug3

Aug7

Implementations

impl Interval

pub const MAX: Interval

The biggest interval is an augmented seventh

pub const MIN: Interval

The smallest interval is a diminished second

pub const DELTA_ENHARMONIC: i8

The number of steps along the line of fifths to an enharmonic variant

#[must_use]pub fn enharmonic(self, other: Interval) -> bool

Whether the two intervals are enharmonic, i.e. represent the same distance in semitones in twelve tone equal temperament.

assert!(Interval::Aug4.enharmonic(Interval::Dim5));
assert!(Interval::Aug2.enharmonic(Interval::Min3));
assert!(!Interval::Unison.enharmonic(Interval::Aug1));

Trait Implementations

impl Add<Interval> for Interval

type Output = Option<Self>

The resulting type after applying the + operator.

fn add(self, rhs: Interval) -> Self::Output

Performs the + operation.

impl Add<Interval> for Tpc

type Output = Option<Tpc>

The resulting type after applying the + operator.

fn add(self, rhs: Interval) -> Self::Output

Performs the + operation.

impl Clone for Interval

fn clone(&self) -> Interval

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Interval

impl Debug for Interval

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

Formats the value using the given formatter.

impl Default for Interval

fn default() -> Self

Returns the "default value" for a type.

impl Eq for Interval

impl FromPrimitive for Interval

fn from_i64(n: i64) -> Option<Self>

Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u64(n: u64) -> Option<Self>

Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_isize(n: isize) -> Option<Self>

Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i8(n: i8) -> Option<Self>

Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i16(n: i16) -> Option<Self>

Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i32(n: i32) -> Option<Self>

Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i128(n: i128) -> Option<Self>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_usize(n: usize) -> Option<Self>

Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u8(n: u8) -> Option<Self>

Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u16(n: u16) -> Option<Self>

Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u32(n: u32) -> Option<Self>

Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u128(n: u128) -> Option<Self>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f32(n: f32) -> Option<Self>

Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f64(n: f64) -> Option<Self>

Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

impl Ord for Interval

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<Interval> for Interval

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Interval> for Interval

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

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

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

impl StructuralEq for Interval

impl StructuralPartialEq for Interval

impl Sub<Interval> for Interval

type Output = Option<Self>

The resulting type after applying the - operator.

fn sub(self, rhs: Interval) -> Self::Output

Performs the - operation.

impl Sub<Interval> for Tpc

type Output = Option<Tpc>

The resulting type after applying the - operator.

fn sub(self, rhs: Interval) -> Self::Output

Performs the - operation.