Struct music_theory::theory::interval::Interval

pub struct Interval(/* private fields */);

An interval is a distance between notes.

Example:

use music_theory::theory::*;
assert_eq!(Note::C2 - Note::A2, Interval::new(3));

Implementations

impl Interval

pub const MAX: Self = _

The biggest valid interval.

pub const MIN: Self = _

The smallest valid interval.

pub const SEMI: Self = _

One semi tone

pub const WHOLE: Self = _

One whole tone

pub const FLAT2: Self = _

The interval equivalent of two flats on a note.

pub const FLAT: Self = _

The interval equivalent of a flat on a note.

pub const NAT: Self = _

The interval equivelant of a natural accidental.

pub const SHARP: Self = _

The interval equivelant of a sharp on a note.

pub const SHARP2: Self = _

The interval equivalent of two sharps on a note.

pub const ROOT: Self = _

The root interval, a distance of zero..

pub const MIN2: Self = _

Minor second.

pub const MAJ2: Self = _

Major second.

pub const MIN3: Self = _

Minor third.

pub const MAJ3: Self = _

Major third.

pub const PER4: Self = _

Perfect fourth.

pub const TRIT: Self = _

Tritone.

pub const PER5: Self = _

Perfect fifth.

pub const MIN6: Self = _

Minor sixth.

pub const MAJ6: Self = _

Major sixth.

pub const MIN7: Self = _

Minor seventh.

pub const MAJ7: Self = _

Major seventh.

pub const OCTAVE: Self = _

Octave.

pub const MIN9: Self = _

Minor nineth.

pub const MAJ9: Self = _

Major nineth.

pub const AUG9: Self = _

Augmented nineth.

pub const MIN11: Self = _

Minor eleventh.

pub const MAJ11: Self = _

Major eleventh.

pub const AUG11: Self = _

Augmented eleventh.

pub const PER12: Self = _

Perfect twelve, octave equivalent of a perfect fifth.

pub const MIN13: Self = _

Minor thirteenth.

pub const MAJ13: Self = _

Major thirteenth.

pub const AUG13: Self = _

Augmented thirteenth.

pub const DIM2: Self = _

Diminished second, octave equivalent of the root.

pub const AUG1: Self = _

Augmented first, octave equivalent of a minor second.

pub const DIM3: Self = _

Diminished third, octave equivalent of a major second.

pub const AUG2: Self = _

Augmented second, octave equivalent of a minor third.

pub const DIM4: Self = _

Diminished fourth, octave equivalent of a major third.

pub const AUG3: Self = _

Augmented third, octave equivalent of a perfect fourth.

pub const DIM5: Self = _

Diminished fifth, octave equivalent of a tritone.

pub const AUG4: Self = _

Augmented fourth, octave equivalent of a tritone.

pub const DIM6: Self = _

Diminished sixth, octave equivalent of a perfect fifth.

pub const AUG5: Self = _

Augmented fifth, octave equivalent of a minor sixth.

pub const DIM7: Self = _

Diminished seventh, octave equivalent of a major sixth.

pub const AUG6: Self = _

Augmented sixth, octave equivalent of a minor seventh.

pub const DIM8: Self = _

Diminished eight, octave equivalent of a major seventh.

pub const AUG7: Self = _

Augmented seventh, octave equivalent of an octave.

pub fn new(i: i32) -> Self

Create a new interval from an integer. Will be clamped if needed to ensure the interval is valid.

Example:

use music_theory::theory::*;
assert_eq!(Note::B2 - Note::A2, Interval::new(2));

pub fn new_try(i: i32) -> Option<Self>

Create a new interval from an integer. If the integer is out of range of valid intervals, it will return None.

Example:

use music_theory::theory::*;
assert_eq!(Interval::new_try(7), Some(Interval::PER5));
assert_eq!(Interval::new_try((1 << 30) + 1), None)

pub fn abs(self) -> Self

Returns the absolute value of the interval.

Example:

use music_theory::theory::*;
assert_eq!(Interval::FLAT2.abs(), Interval::SHARP2);

pub fn abs_note(self) -> Note

Returns the absolute value of the interval inside a Note type.

Example:

use music_theory::theory::*;
assert_eq!(Interval::MIN3.abs_note(), note_interval::MIN3);

pub fn to_string_nat(&self) -> String

Returns the interval spelled out in accidentals. Will spell the zero interval with a natural accidental.

Example:

use music_theory::theory::*;
assert_eq!(&Interval::FLAT2.to_string_nat(), "♭♭");
assert_eq!(&Interval::ROOT.to_string_nat(), "♮");

Trait Implementations

impl Add for Interval

type Output = Interval

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self::Output

Performs the + operation.

impl AddAssign for Interval

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl AddInterval for Interval

fn add_interval(self, interval: Interval) -> Option<Self>

Add an Interval.

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 Debug for Interval

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

Formats the value using the given formatter.

impl Default for Interval

fn default() -> Interval

Returns the “default value” for a type.

impl Display for Interval

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

Formats the value using the given formatter.

impl GeneratablePartialOrder for Interval

fn next(self) -> Option<Interval>

Generate the next item.

fn prev(self) -> Option<Interval>

Generate the previous item.

impl Hash for Interval

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 Neg for Interval

type Output = Interval

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl OctaveShiftable for Interval

fn with_octave(self, octave: Octave) -> Self

Have the value with everything the same except change the octave to the given one.

fn shift_octave(self, shift: OctaveShift) -> Self

Have the value with everything the same except shift the octave from the current one with the given shift.

impl Ord for Interval

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

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

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

fn start_bound(&self) -> Bound<&Self>

Start index bound.

fn end_bound(&self) -> Bound<&Self>

End index bound.

fn contains<U>(&self, item: &U) -> bool

where T: PartialOrd<U>, U: PartialOrd<T> + ?Sized,

Returns true if item is contained in the range.

impl Sub for Interval

type Output = Interval

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self::Output

Performs the - operation.

impl SubAssign for Interval

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl ToNamedInterval for Interval

fn to_named_interval_try(self) -> Option<NamedInterval>

Try to convert to NamedInterval.

fn to_named_interval_mod(self) -> NamedInterval

Convert to NamedInterval with wrapping around the octaves.

impl ToNamedOctaveInterval for Interval

fn to_named_octave_interval_try(self) -> Option<NamedOctaveInterval>

Try to convert to NamedOctaveInterval.

fn to_named_octave_interval_mod(self) -> NamedOctaveInterval

Convert to NamedOctaveInterval with wrapping around the octave.

impl Wrapper for Interval

type Inner = i32

The type the new type wraps.

fn wrap(interval: Self::Inner) -> Option<Self>

Try to wrap a Self::Inner type into the Self type.

fn unwrap(self) -> Self::Inner

Unwrap a Self type into a Self::Inner type.

impl Copy for Interval

impl Eq for Interval

impl StructuralPartialEq for Interval