Enum FunctionMap 

pub enum FunctionMap {
    Major,
    MinorNatural,
    MinorHarmonic,
    MinorMelodicAsc,
    Dorian,
    Phrygian,
    Lydian,
    Mixolydian,
    Locrian,
    Custom(Scale),
}

Named diatonic function (mode) used to remap scale degrees onto pitches.

Variants

Major

Major (Ionian) function.

MinorNatural

Natural minor (Aeolian) function.

MinorHarmonic

Harmonic minor function.

MinorMelodicAsc

Ascending melodic minor function.

Dorian

Dorian mode function.

Phrygian

Phrygian mode function.

Lydian

Lydian mode function.

Mixolydian

Mixolydian mode function.

Locrian

Locrian mode function.

Custom(Scale)

User-supplied scale used directly as the function.

Implementations

impl FunctionMap

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

Returns the stable wire/display name for this function.

pub fn scale_for_key(&self, key: &Key) -> Scale

Builds the concrete Scale this function produces for the given key.

pub fn degree_to_pitch( &self, degree: usize, key: &Key, octave: i16, ) -> Result<Pitch, PitchScaleError>

Resolves a scale degree to a concrete pitch at the given octave.

Trait Implementations

impl Clone for FunctionMap

fn clone(&self) -> FunctionMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionMap

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

Formats the value using the given formatter.

impl Eq for FunctionMap

impl PartialEq for FunctionMap

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FunctionMap