Struct DiatonicInterval 

pub struct DiatonicInterval { /* private fields */ }

A quality and a generic interval together: M3, -P5, dd7.

Implementations

impl DiatonicInterval

pub fn new(specifier: Specifier, generic: &GenericInterval) -> Self

Pairs a quality with a generic interval without checking that the pair exists; see Self::try_new for the checked form.

pub fn try_new(specifier: Specifier, generic: GenericInterval) -> Result<Self>

Pairs a quality with a generic interval, rejecting the combinations music21 rejects: major and minor on a perfectable interval, perfect on the others, and a descending perfect unison.

pub fn from_name(name: &str) -> Result<Self>

Parses a diatonic interval from a name such as M3, -P5 or Major Third.

pub fn specifier_abbreviation(&self) -> &'static str

The quality.

pub fn specifier(&self) -> Specifier

The quality of the interval.

pub fn generic(&self) -> &GenericInterval

The generic interval.

pub fn name(&self) -> String

The short name without direction, M3, P5, dd7.

pub fn nice_name(&self) -> String

The spelled-out name, Major Third.

pub fn directed_name(&self) -> String

The short name with the direction, M-3 for a descending third, which is where music21 puts the hyphen.

pub fn directed_nice_name(&self) -> String

The spelled-out name with the direction, Descending Major Third.

pub fn simple_name(&self) -> String

The short name of the simple interval, so M10 is M3.

pub fn semi_simple_name(&self) -> String

The short name of the semi-simple interval, so P15 is P8.

pub fn simple_nice_name(&self) -> String

The spelled-out name of the simple interval.

pub fn semi_simple_nice_name(&self) -> String

The spelled-out name of the semi-simple interval.

pub fn directed_simple_name(&self) -> String

The short directed name of the simple interval, M-3 for a descending tenth.

pub fn directed_semi_simple_name(&self) -> String

The short directed name of the semi-simple interval.

pub fn directed_simple_nice_name(&self) -> String

The spelled-out directed name of the simple interval.

pub fn directed_semi_simple_nice_name(&self) -> String

The spelled-out directed name of the semi-simple interval.

pub fn specific_name(&self) -> String

The quality’s spelled-out name alone, Major.

pub fn direction(&self) -> Direction

Ascending, descending, or oblique. A unison takes its direction from the quality: an augmented unison ascends and a diminished one descends, as music21 reads them.

pub fn cents(&self) -> Result<FloatType>

The size in cents, signed, from the chromatic equivalent.

pub fn mod7(&self) -> String

The name of the simple interval measured upward, so a descending major third is m6.

pub fn mod7_inversion(&self) -> String

The name of the inversion of the simple interval: M3 becomes m6.

pub fn is_step(&self) -> bool

Whether the interval is a second in either direction.

pub fn is_diatonic_step(&self) -> bool

The same as Self::is_step.

pub fn is_skip(&self) -> bool

Whether the interval is larger than a second.

pub fn is_perfectable(&self) -> bool

Whether the generic interval takes perfect qualities.

pub fn get_chromatic(&self) -> Result<ChromaticInterval>

The semitone count the quality and generic interval add up to.

pub fn reverse(&self) -> Self

The same interval in the other direction. A unison keeps its generic value and inverts its quality instead, since an augmented unison downward is a diminished one.

pub fn transpose_pitch(&self, pitch: &Pitch) -> Result<Pitch>

Moves a pitch by the interval, spelling the result by the quality.

Trait Implementations

impl Clone for DiatonicInterval

fn clone(&self) -> DiatonicInterval

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DiatonicInterval

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DiatonicInterval

Available on crate feature serde only.

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DiatonicInterval

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

Formats the value using the given formatter.

impl Eq for DiatonicInterval

impl PartialEq for DiatonicInterval

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

Two diatonic intervals are equal when their generic value, specifier and direction agree, as in music21.

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

Inequality operator !=.

impl Serialize for DiatonicInterval

Available on crate feature serde only.

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.