Struct GenericInterval 

pub struct GenericInterval { /* private fields */ }

A directed interval counted in scale steps: 3 is a third up, -3 a third down, 1 a unison. Zero is not an interval.

Implementations

impl GenericInterval

pub fn new(value: IntegerType) -> Result<Self>

A generic interval of value steps, signed. Zero is an error, as music21 says: “The Zeroth is not an interval”.

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

Parses a generic interval from music21’s spellings: a number, an ordinal such as "third" or "octave", optionally preceded by "descending" or "ascending".

pub fn value(&self) -> IntegerType

The signed step count: music21’s value and directed.

pub fn directed(&self) -> IntegerType

The signed step count.

pub fn undirected(&self) -> IntegerType

The step count without its sign.

pub fn direction(&self) -> Direction

Ascending, descending, or oblique for a unison.

pub fn simple_directed(&self) -> IntegerType

The interval within one octave, keeping the sign, so a descending ninth is -2 and any octave is 1.

pub fn simple_undirected(&self) -> IntegerType

The interval within one octave, without the sign.

pub fn semi_simple_directed(&self) -> IntegerType

Like Self::simple_directed, but an octave stays 8 (or -8) rather than folding to a unison.

pub fn semi_simple_undirected(&self) -> IntegerType

Like Self::simple_undirected, but an octave stays 8.

pub fn undirected_octaves(&self) -> IntegerType

How many whole octaves the interval spans, ignoring direction.

pub fn octaves(&self) -> IntegerType

How many whole octaves the interval spans, negative when descending.

pub fn staff_distance(&self) -> IntegerType

The signed number of staff positions moved: a third is 2, a descending third -2, a unison 0.

pub fn mod7(&self) -> IntegerType

The simple interval measured upward, so a descending third is 6.

pub fn mod7_inversion(&self) -> IntegerType

The inversion of the simple interval: a third becomes a sixth.

pub fn is_perfectable(&self) -> bool

Whether the simple interval is a unison, fourth or fifth, the ones that take perfect rather than major and minor qualities.

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, as music21 defines isDiatonicStep on a generic interval.

pub fn is_skip(&self) -> bool

Whether the interval is larger than a second.

pub fn is_unison(&self) -> bool

Whether the interval is a unison.

pub fn nice_name(&self) -> String

The spelled-out name, Third, Octave, Fifteenth, 23rd.

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 complement(&self) -> Self

The interval that completes the octave: a third’s complement is a sixth, whatever the direction.

pub fn reverse(&self) -> Self

The same interval in the other direction; a unison stays a unison.

pub fn get_diatonic(&self, spec: Specifier) -> DiatonicInterval

Pairs the interval with a quality.

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

Moves a pitch by the staff distance, keeping its accidental, as music21’s generic transposePitch does: a third above C#4 is E#4.

pub fn transpose_pitch_key_aware( &self, pitch: &Pitch, key_signature: Option<&KeySignature>, ) -> Result<Pitch>

Moves a pitch by the staff distance, taking the accidental from the key signature when one is given and the pitch had none of its own.

Trait Implementations

impl Clone for GenericInterval

fn clone(&self) -> GenericInterval

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GenericInterval

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GenericInterval

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 GenericInterval

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

Formats the value using the given formatter.

impl Eq for GenericInterval

impl Hash for GenericInterval

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 PartialEq for GenericInterval

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for GenericInterval

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 GenericInterval