Enum HarmonicFunction 

pub enum HarmonicFunction {
    TonicMajor,
    TonicMajorParallelklangMinor,
    TonicMajorGegenklangMinor,
    TonicMinor,
    TonicMinorParallelklangMajor,
    TonicMinorGegenklangMajor,
    SubdominantMajor,
    SubdominantMajorParallelklangMinor,
    SubdominantMajorGegenklangMinor,
    SubdominantMinor,
    SubdominantMinorParallelklangMajor,
    SubdominantMinorGegenklangMajor,
    DominantMajor,
    DominantMajorParallelklangMinor,
    DominantMajorGegenklangMinor,
    DominantMinor,
    DominantMinorParallelklangMajor,
    DominantMinorGegenklangMajor,
}

One of the eighteen harmonic function labels.

Variants

TonicMajor

T

TonicMajorParallelklangMinor

Tp

TonicMajorGegenklangMinor

Tg

TonicMinor

t

TonicMinorParallelklangMajor

tP

TonicMinorGegenklangMajor

tG

SubdominantMajor

S

SubdominantMajorParallelklangMinor

Sp

SubdominantMajorGegenklangMinor

Sg

SubdominantMinor

s

SubdominantMinorParallelklangMajor

sP

SubdominantMinorGegenklangMajor

sG

DominantMajor

D

DominantMajorParallelklangMinor

Dp

DominantMajorGegenklangMinor

Dg

DominantMinor

d

DominantMinorParallelklangMajor

dP

DominantMinorGegenklangMajor

dG

Implementations

impl HarmonicFunction

pub const ALL: [Self; 18]

All eighteen, in music21’s order.

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

The label: T, Tp, sG and so on.

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

music21’s member name: TONIC_MAJOR, SUBDOMINANT_MINOR_GEGENKLANG_MAJOR.

pub fn from_symbol(symbol: &str) -> Result<Self>

The function a label names, case and all.

Errors

A label that is none of the eighteen, TPG say.

pub fn main_function(self) -> Self

The main function alone, the label’s first letter: sP is s.

pub fn figure(self, mode: &str) -> &'static str

The Roman numeral figure this function has in a key of mode: sP is bVI in major and VI in minor.

pub fn to_roman(self, key: &Key) -> Result<RomanNumeral>

The Roman numeral this function is in key: music21’s functionToRoman.

use music21_rs::{Key, analysis::harmonic_function::HarmonicFunction};

let minor = Key::from_tonic_mode("a", "minor")?;
let numeral = HarmonicFunction::SubdominantMinorParallelklangMajor.to_roman(&minor)?;
assert_eq!(numeral.figure(), "VI");

Errors

None in practice: every figure in the tables is one a Roman numeral reads.

pub fn from_roman( numeral: &RomanNumeral, detail: FunctionDetail, ) -> Option<Self>

The function a Roman numeral has, read off its numeral and front alteration alone, so inversions and figures do not count: music21’s romanToFunction. Where two functions share a numeral, the first in music21’s table wins: vi is Tp. Nothing for a numeral no function has.

Trait Implementations

impl Clone for HarmonicFunction

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 HarmonicFunction

impl Debug for HarmonicFunction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HarmonicFunction

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 HarmonicFunction

impl Hash for HarmonicFunction

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 HarmonicFunction

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for HarmonicFunction

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 HarmonicFunction