Struct persichetti::primitives::Interval

pub struct Interval { /* fields omitted */ }

An Interval is a combination of an IntervalSize and an IntervalQuality. It represents the relationship between two Notes.

Implementations

impl Interval

pub fn new(
    size: IntervalSize,
    quality: IntervalQuality
) -> Result<Interval, IntervalError>

Instantiate a new Interval. If an invalid combination is entered, such as a major fourth or a perfect third, the function will return an error.

pub fn from_str(input: &str) -> Result<Interval, IntervalError>

Instantiate an Interval using the shorthand documented in crate::primitives. If the token cannot be parsed or the desired interval is invalid, an error will be returned.

pub fn size(&self) -> &IntervalSize

pub fn quality(&self) -> &IntervalQuality

pub fn chromatic_size(&self) -> isize

The number of half steps between the top and bottom note in the interval. In the case of a diminished unison, the output could be negative

assert_eq!(7, Interval::new(Fifth, Perfect)?.chromatic_size());
assert_eq!(-1, Interval::new(Unison, Diminished(0))?.chromatic_size());
assert_eq!(-3, Interval::new(Second, Diminished(3))?.chromatic_size());

pub fn from_notes(lower: &Note, higher: &Note) -> Interval

Given two Notes, calculate the interval that describes their relationship. While there is discourse around the existence of a diminished unison, this library acknowledges its existence since there is no concept of an octave.

assert_eq!(ivl!("A6")?, Interval::from_notes(&note!("Bb")?, &note!("G#")?));
assert_eq!(ivl!("dU")?, Interval::from_notes(&note!("F#")?, &note!("F")?));

pub fn inverse(&self) -> Interval

The inverse of an interval I can be defined as the interval I′ such that the sum of I and I′ is an octave (or unison, in this case)

Trait Implementations

impl Add<&'_ Interval> for &Note

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

Adding an Interval I to a Note N will yeild a new note whose distance N is exactly I.

type Output = Note

The resulting type after applying the + operator.

impl Add<&'_ Interval> for &Interval

type Output = Interval

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Interval> for Note

type Output = Note

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Interval> for Interval

type Output = Interval

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

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

Formats the value using the given formatter.

impl Display for Interval

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

Formats the value using the given formatter.

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, 

Feeds a slice of this type into the given Hasher.

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 ==.

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

This method tests for !=.

impl Sub<&'_ Interval> for &Note

type Output = Note

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<Interval> for Note

type Output = Note

The resulting type after applying the - operator.

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

Performs the - operation.

impl Eq for Interval

impl StructuralEq for Interval

impl StructuralPartialEq for Interval