Struct ChromaticInterval 

pub struct ChromaticInterval { /* private fields */ }

A signed number of semitones, fractional for microtonal intervals.

Implementations

impl ChromaticInterval

pub fn new(semitones: FloatType) -> Result<Self>

A chromatic interval of semitones, negative for descending and fractional for a microtonal one: a quarter tone is 0.5.

A count that is not finite spells no interval. It used to spell a perfect unison: what reads an interval off a count casts it first, and a cast answers nought for anything it cannot represent.

pub fn from_int(semitones: IntegerType) -> Self

A chromatic interval of a whole number of semitones.

pub fn semitones(&self) -> FloatType

The signed semitone count.

pub fn directed(&self) -> FloatType

The signed semitone count: music21’s directed.

pub fn undirected(&self) -> FloatType

The semitone count without its sign.

pub fn whole_semitones(&self) -> IntegerType

The semitone count rounded to a whole number, which is how music21 reads a microtonal interval wherever it needs a diatonic spelling or a pitch class.

pub fn direction(&self) -> Direction

Ascending, descending, or oblique for no semitones at all.

pub fn cents(&self) -> FloatType

The size in cents, signed, so a quarter tone is 50.0.

pub fn mod12(&self) -> IntegerType

The semitones reduced to a pitch class, 0 to 11, so a descending major third is 8.

pub fn simple_directed(&self) -> IntegerType

The semitones within one octave, keeping the sign.

pub fn simple_undirected(&self) -> IntegerType

The semitones within one octave, without the sign.

pub fn interval_class(&self) -> IntegerType

The interval class, 0 to 6: the smaller of the pitch-class distance and its complement.

pub fn is_chromatic_step(&self) -> bool

Whether the interval is one semitone either way.

pub fn is_step(&self) -> bool

The same as Self::is_chromatic_step, as music21 defines isStep on a chromatic interval.

pub fn reverse(&self) -> Self

The same interval in the other direction.

pub fn get_diatonic(&self) -> DiatonicInterval

The simplest diatonic spelling of the semitone count, as music21’s getDiatonic reads it: six semitones are a diminished fifth, one a minor second, and a microtonal count is rounded to the nearest of those.

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

Moves a pitch by the semitone count, respelling it from its new pitch space the way music21’s chromatic transposePitch does. A pitch without an octave keeps having none.

Trait Implementations

impl Clone for ChromaticInterval

fn clone(&self) -> ChromaticInterval

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChromaticInterval

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChromaticInterval

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 ChromaticInterval

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

Formats the value using the given formatter.

impl PartialEq for ChromaticInterval

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ChromaticInterval

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.

impl StructuralPartialEq for ChromaticInterval