Struct FiguredBassScale 

pub struct FiguredBassScale { /* private fields */ }

The key a figured bass is counted in: a tonic and a mode.

use music21::Pitch;
use music21::figuredbass::Notation;
use music21::figuredbass::scale::FiguredBassScale;

let c_major = FiguredBassScale::default();
let first_inversion = Notation::parse("6")?;
let names = c_major.pitch_names(&Pitch::from_name("D3")?, &first_inversion)?;
assert_eq!(names, ["D", "F", "B"]);

Implementations

impl FiguredBassScale

pub fn new(tonic: Pitch, mode: FiguredBassMode) -> Result<Self>

The scale of mode on tonic.

Errors

A tonic with no key signature in that mode.

pub fn with_scale(self, scale: Scale) -> Self

The same, counting its figures in scale: music21’s realizerScale assigned. The key signature and mode are left as they were, as music21 leaves them.

pub fn with_key_signature(self, key_signature: KeySignature) -> Self

The same, spelling a bass the scale does not carry by key_signature: music21’s keySig assigned.

pub fn mode(&self) -> FiguredBassMode

The mode it is in.

pub fn scale(&self) -> &Scale

The scale itself: music21’s realizerScale.

pub fn key_signature(&self) -> &KeySignature

The key signature the tonic and mode are written with: music21’s keySig.

pub fn pitch_names( &self, bass: &Pitch, notation: &Notation, ) -> Result<Vec<String>>

The names of the notes bass and notation stand for, the bass first and the rest in the order the figures give them: music21’s getPitchNames.

A bass the scale does not carry is read as the scale’s own note on its letter, spelled as the key signature spells it, which is how a chromatic bass is still counted from.

Errors

A bass whose letter the scale cannot find, or a figure its modifier cannot be applied to.

pub fn sample_pitches( &self, bass: &Pitch, notation: &Notation, ) -> Result<Vec<Pitch>>

Every note bass and notation stand for from the bass up to, but not including, the octave above it: the closest the chord can be voiced. music21’s getSamplePitches.

Errors

As FiguredBassScale::pitch_names.

pub fn pitches( &self, bass: &Pitch, notation: &Notation, max_pitch: Option<&Pitch>, ) -> Result<Vec<Pitch>>

Every note bass and notation stand for, in every octave from the bass up to max_pitch (B5 unless given), both included, lowest first: music21’s getPitches.

Errors

As FiguredBassScale::pitch_names.

Trait Implementations

impl Clone for FiguredBassScale

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FiguredBassScale

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

Formats the value using the given formatter.

impl Default for FiguredBassScale

fn default() -> Self

C major, as music21’s is when given nothing.

impl<'de> Deserialize<'de> for FiguredBassScale

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

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

Two are equal when they are one mode on one tonic; the key signature follows from those.

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

Inequality operator !=.

impl Serialize for FiguredBassScale

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.