Struct musical_note::ResolvedScale

pub struct ResolvedScale {
    pub key: Key,
    pub degree_midi: [u8; 7],
    pub degree_notes: [(NoteName, Accidental); 7],
    pub used_accidentals: Vec<Accidental>,
}

Concrete Scale representation, based on the given root note.

Used to estimate alteration for notes, can be alterated by scale rules.

Fields

key: Key

degree_midi: [u8; 7]

0..12 midi bytes, representing every grade of the scale. E.g. for C-Dur it would be: [0, 2, 4, 5, 7, 9, 11], and for A-moll: [9, 11, 0, 2, 4, 5, 7]

degree_notes: [(NoteName, Accidental); 7]

the same, but, holding Tuples of note names and accidentals.

used_accidentals: Vec<Accidental>

Collects accidentals, used for degrees to estimate, which alteration of non-degree notes is preferable. TODO: think on using this as weight.

Implementations

impl ResolvedScale

pub fn resolve_pitch(
    &self,
    notes_map: &NotesMap,
    midi_note: u8,
    octave: Octave
) -> ResolvedNote

Examples found in repository

src/lib.rs (line 262)

    pub fn resolve(&self, key: Key) -> ResolvedNote {
        let (midi_note, octave) = Octave::split_midi(self.midi);
        // let midi_note = self.midi % 12;
        let notes_map = NotesMap::get();
        let res = self.resolve_by_accident(&notes_map, midi_note, octave);
        if res.is_some() {
            return res.unwrap();
        }
        let scale = key.resolve_scale(&notes_map);

        scale.resolve_pitch(notes_map, midi_note, octave)
    }

Trait Implementations

impl Clone for ResolvedScale

fn clone(&self) -> ResolvedScale

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ResolvedScale

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResolvedScale

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<ResolvedScale> for ResolvedScale

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ResolvedScale

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ResolvedScale

impl StructuralEq for ResolvedScale

impl StructuralPartialEq for ResolvedScale