Enum KeyProfile 

pub enum KeyProfile {
    KrumhanslSchmuckler,
    AardenEssen,
    SimpleWeights,
    BellmanBudge,
    TemperleyKostkaPayne,
}

A set of key-finding weights for the Krumhansl-Schmuckler algorithm.

These are the profiles music21’s analysis.discrete ships, with the characterisations Craig Sapp gives them in the Humdrum keycor manual.

Variants

KrumhanslSchmuckler

Krumhansl and Kessler’s 1982 probe-tone ratings. Strong tendency to name the dominant as the tonic.

AardenEssen

Aarden’s 2003 profile from the Essen folksong collection, music21’s default. Weak tendency to name the subdominant as the tonic.

SimpleWeights

Sapp’s simple weights, most consistent over long stretches of music.

BellmanBudge

Bellman and Budge’s profile, with no particular neighbouring-key bias.

TemperleyKostkaPayne

Temperley’s Kostka-Payne corpus profile. Strong tendency to name the relative major in minor keys.

Implementations

impl KeyProfile

pub const ALL: [KeyProfile; 5]

Every profile, in music21’s order.

pub fn major_weights(self) -> [FloatType; 12]

The weights for the twelve pitch classes above a major tonic.

pub fn minor_weights(self) -> [FloatType; 12]

The weights for the twelve pitch classes above a minor tonic.

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

The name of the music21 class carrying these weights.

Trait Implementations

impl Clone for KeyProfile

fn clone(&self) -> KeyProfile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for KeyProfile

impl Debug for KeyProfile

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyProfile

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 KeyProfile

impl Hash for KeyProfile

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 Ord for KeyProfile

fn cmp(&self, other: &KeyProfile) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for KeyProfile

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for KeyProfile

fn partial_cmp(&self, other: &KeyProfile) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for KeyProfile

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 KeyProfile