Struct RomanNumeral 

pub struct RomanNumeral { /* private fields */ }

A parsed Roman numeral in a key.

Implementations

impl RomanNumeral

pub fn new(figure: impl Into<String>, key: Key) -> Result<Self>

Parses a Roman numeral figure in a key.

Supports ordinary figures such as V7/V and augmented-sixth figures such as It+6, Fr+6, Ger+6, and Sw+6.

pub fn figure(&self) -> &str

Returns the original figure.

pub fn degree(&self) -> u8

Returns the one-based scale degree.

pub fn accidental(&self) -> i8

Returns the chromatic alteration of the scale degree in semitones.

Negative values are flats and positive values are sharps, so bII returns -1 and #iv returns 1.

pub fn inversion(&self) -> u8

Returns the inversion number, where root position is 0.

pub fn secondary(&self) -> Option<&str>

Returns the secondary/applied target figure, if any.

pub fn key(&self) -> &Key

Returns the key context.

pub fn to_chord(&self) -> Result<Chord>

Realizes the Roman numeral as a chord.

pub fn analyze(chord: &Chord, key: Key) -> Result<Option<Self>>

Performs functional Roman-numeral analysis in a key.

pub fn analyze_with_root( chord: &Chord, key: Key, root: &Pitch, ) -> Result<Option<Self>>

Performs Roman-numeral analysis using an explicit harmonic root.

This is useful for pitch-class-set browser views where the caller has already chosen a transposition root and does not want inversion or root inference to pick a different chord member.

Trait Implementations

impl Clone for RomanNumeral

fn clone(&self) -> RomanNumeral

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RomanNumeral

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

Formats the value using the given formatter.

impl Display for RomanNumeral

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

Formats the value using the given formatter.