Struct EnharmonicRules 

pub struct EnharmonicRules { /* private fields */ }

The three penalties a spelling is scored by: music21’s EnharmonicScoreRules and its subclasses. A penalty of None or nought is off, and scores 1 whatever the spelling.

Implementations

impl EnharmonicRules

pub const MELODIC: Self

music21’s EnharmonicScoreRules: mixing sharps and flats costs nothing.

pub const CHORDAL: Self

music21’s ChordEnharmonicScoreRules: mixing sharps and flats costs two for each of the rarer kind.

pub fn new( alteration: Option<IntegerType>, aug_dim: Option<IntegerType>, mixture: Option<IntegerType>, ) -> Self

Rules with the penalties given: what each sharp or flat costs, each augmented or diminished step, and each accidental of the rarer kind.

pub fn alteration_penalty(self) -> Option<IntegerType>

What each sharp or flat costs, if anything.

pub fn aug_dim_penalty(self) -> Option<IntegerType>

What each augmented or diminished step costs, if anything.

pub fn mixture_penalty(self) -> Option<IntegerType>

What each accidental of the rarer kind costs, if anything.

pub fn alteration_score(self, spelling: &[Pitch]) -> IntegerType

music21’s getAlterationScore: one more than the sharps and flats in spelling, times the alteration penalty.

pub fn mixture_score(self, spelling: &[Pitch]) -> IntegerType

music21’s getMixSharpFlatsScore: the count of the rarer of sharps and flats in spelling, times the mixture penalty.

pub fn aug_dim_score(self, spelling: &[Pitch]) -> Result<IntegerType>

music21’s getAugDimScore: one more than the augmented and diminished steps between neighbours in spelling, times the aug/dim penalty. E- G# is one, an augmented third.

Errors

A neighbour spelled with an accidental base 40 has no place for, such as a triple sharp or a microtone’s step.

Trait Implementations

impl Clone for EnharmonicRules

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for EnharmonicRules

impl Debug for EnharmonicRules

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

Formats the value using the given formatter.

impl Default for EnharmonicRules

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EnharmonicRules

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 Eq for EnharmonicRules

impl Hash for EnharmonicRules

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 EnharmonicRules

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for EnharmonicRules

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 EnharmonicRules