Enum music_theory::theory::interval::NamedInterval

pub enum NamedInterval {
    Root = 0,
    Min2 = 1,
    Maj2 = 2,
    Min3 = 3,
    Maj3 = 4,
    Per4 = 5,
    Trit = 6,
    Per5 = 7,
    Min6 = 8,
    Maj6 = 9,
    Min7 = 10,
    Maj7 = 11,
    Per8 = 12,
    Min9 = 13,
    Maj9 = 14,
    Aug9 = 15,
    Min11 = 16,
    Maj11 = 17,
    Aug11 = 18,
    Min13 = 20,
    Maj13 = 21,
    Aug13 = 22,
}

An interval with a distinct name

Variants

Root = 0

The root interval is an interval of zero.

Min2 = 1

Minor second interval.

Maj2 = 2

Major second interval.

Min3 = 3

Minor third interval.

Maj3 = 4

Major third interval.

Per4 = 5

Perfect fourth interval.

Trit = 6

Tritone interval.

Per5 = 7

Perfect fifth interval.

Min6 = 8

Minor sixth interval.

Maj6 = 9

Major sixth interval.

Min7 = 10

Minor seventh interval.

Maj7 = 11

Major seventh interval.

Per8 = 12

Perfect eight interval, same as an octave.

Min9 = 13

Minor nineth interval, octave equivalent to a minor second.

Maj9 = 14

Major nineth interval, octave equivalent to a major second.

Aug9 = 15

Augmented nineth interval, octave equivalent to a minor third.

Min11 = 16

Minor eleventh interval, octave equivalent to a major third.

Maj11 = 17

Major eleventh interval, octave equivalent to a perfect fourth.

Aug11 = 18

Augmented eleventh interval, octave equivalent to a tritone.

Min13 = 20

Minor thirteenth interval, octave equivalent to a minor sixth.

Maj13 = 21

Major thirteenth interval, octave equivalent to a major sixth.

Aug13 = 22

Augmented thirteenth interval, octave equivalent to a minor seventh.

Implementations

impl NamedInterval

pub const ALL: [Self; 22] = _

All named intervals so you iterate over them.

Example:

use music_theory::theory::*;
assert_eq!(NamedInterval::ALL.iter().copied().next(), Some(NamedInterval::Root));

Trait Implementations

impl Clone for NamedInterval

fn clone(&self) -> NamedInterval

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NamedInterval

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

Formats the value using the given formatter.

impl Display for NamedInterval

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

Formats the value using the given formatter.

impl Hash for NamedInterval

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 NamedInterval

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

Restrict a value to a certain interval.

impl PartialEq for NamedInterval

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

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

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

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

impl PartialOrd for NamedInterval

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

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

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

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

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

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

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

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

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 ToInterval for NamedInterval

fn to_interval(self) -> Interval

Take self and return Interval.

impl Copy for NamedInterval

impl Eq for NamedInterval

impl StructuralPartialEq for NamedInterval