Struct ScaleLock 

pub struct ScaleLock {
    pub allowed_classes: Vec<u8>,
}

A set of allowed pitch classes that incoming notes are snapped to.

Holds the permitted pitch classes (0..12); apply maps any pitch to the nearest allowed class.

Examples

use sim_lib_music_core::{Pitch, ScaleLock};

let lock = ScaleLock::major();
// C-sharp (class 1) is not in C major and snaps down to C.
assert_eq!(lock.apply(Pitch::from_semitone(1)).semitone(), 0);
// A pitch already in the scale is left unchanged.
assert_eq!(lock.apply(Pitch::from_semitone(2)).semitone(), 2);

Fields

allowed_classes: Vec<u8>

Sorted, deduplicated allowed pitch classes (each in 0..12).

Implementations

impl ScaleLock

pub fn new(allowed_classes: Vec<u8>) -> Result<Self>

Builds a scale lock from a list of pitch classes.

The list is sorted and deduplicated; returns an error if it is empty or any class is outside 0..12.

pub fn major() -> Self

Returns a scale lock for the diatonic major scale.

pub fn apply(&self, pitch: Pitch) -> Pitch

Snaps pitch to the nearest allowed pitch class.

Pitches already in the lock pass through unchanged; otherwise the smallest semitone shift to an allowed class is applied, preferring downward ties.

Trait Implementations

impl Clone for ScaleLock

fn clone(&self) -> ScaleLock

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScaleLock

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

Formats the value using the given formatter.

impl Eq for ScaleLock

impl PartialEq for ScaleLock

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ScaleLock