Struct PlayerScale 

pub struct PlayerScale {
    pub tonic: PitchClass,
    /* private fields */
}

A performance-oriented scale that owns its interval list, supporting both the built-in Modes and arbitrary custom scales.

Unlike Scale, which is a fixed mode plus tonic, a PlayerScale can hold a caller-supplied set of intervals and provides quantization and remapping for live input.

Fields

tonic: PitchClass

The tonic pitch class.

Implementations

impl PlayerScale

pub fn from_scale(scale: Scale) -> Self

Builds a player scale from a fixed Scale.

pub fn from_key(tonic: PitchClass, mode: Mode) -> Self

Builds a player scale from a tonic and Mode.

pub fn custom( tonic: PitchClass, intervals: impl Into<Vec<u8>>, ) -> Result<Self, PitchScaleError>

Builds a player scale from a custom interval list (semitone offsets from the tonic), which is sorted and deduplicated.

Returns PitchScaleError::EmptyScale if no intervals are given, or PitchScaleError::InvalidScaleInterval if any interval is 12 or more.

pub fn intervals(&self) -> &[u8]

Returns the scale’s semitone offsets from the tonic, in ascending order.

pub fn pitch_classes(&self) -> Vec<PitchClass>

Returns the scale’s pitch classes in ascending degree order.

pub fn contains(&self, class: PitchClass) -> bool

Returns true if class is a member of the scale.

pub fn degree_of(&self, class: PitchClass) -> Option<usize>

Returns the one-based scale degree of class, or None if it is not in the scale.

pub fn pitch_at_degree( &self, degree: usize, ) -> Result<PitchClass, PitchScaleError>

Returns the pitch class at the one-based degree, wrapping past the octave.

pub fn try_pitch_at_degree( &self, degree: usize, ) -> Result<PitchClass, PitchScaleError>

Returns the pitch class at the one-based degree, wrapping past the octave.

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

Returns the in-scale pitch nearest to pitch, breaking ties upward.

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

Remaps pitch onto the scale by treating its chromatic offset from the tonic as a scale degree, preserving the octave.

Trait Implementations

impl Clone for PlayerScale

fn clone(&self) -> PlayerScale

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PlayerScale

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

Formats the value using the given formatter.

impl Eq for PlayerScale

impl Hash for PlayerScale

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for PlayerScale

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PlayerScale