Struct Scale 

pub struct Scale {
    pub tonic: PitchClass,
    pub mode: Mode,
}

A concrete scale: a Mode anchored to a tonic pitch class.

Examples

use sim_lib_pitch_core::PitchClass;
use sim_lib_pitch_scale::Scale;

let c_major = Scale::major(PitchClass::C);
assert_eq!(c_major.degree_of(PitchClass::G), Some(5));

Fields

tonic: PitchClass

The tonic pitch class.

mode: Mode

The mode of the scale.

Implementations

impl Scale

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

Constructs a scale from a tonic and mode.

pub const fn major(tonic: PitchClass) -> Self

Constructs a major scale on tonic.

pub const fn minor_natural(tonic: PitchClass) -> Self

Constructs a natural minor scale on tonic.

pub const fn minor_harmonic(tonic: PitchClass) -> Self

Constructs a harmonic minor scale on tonic.

pub const fn minor_melodic(tonic: PitchClass) -> Self

Constructs a melodic minor scale on tonic.

pub const fn dorian(tonic: PitchClass) -> Self

Constructs a Dorian scale on tonic.

pub const fn phrygian(tonic: PitchClass) -> Self

Constructs a Phrygian scale on tonic.

pub const fn lydian(tonic: PitchClass) -> Self

Constructs a Lydian scale on tonic.

pub const fn mixolydian(tonic: PitchClass) -> Self

Constructs a Mixolydian scale on tonic.

pub const fn aeolian(tonic: PitchClass) -> Self

Constructs an Aeolian scale on tonic.

pub const fn locrian(tonic: PitchClass) -> Self

Constructs a Locrian scale on tonic.

pub const fn whole_tone(tonic: PitchClass) -> Self

Constructs a whole-tone scale on tonic.

pub const fn diminished(tonic: PitchClass) -> Self

Constructs a diminished (octatonic) scale on tonic.

pub const fn chromatic(tonic: PitchClass) -> Self

Constructs a chromatic scale on tonic.

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

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

pub fn mask(self) -> PitchClassMask

Returns the scale’s pitch classes as a PitchClassMask.

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

Returns the one-based scale degree of pitch_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 transpose_diatonic( self, pitch: Pitch, steps: i32, ) -> Result<Pitch, PitchScaleError>

Transposes pitch by steps scale degrees, staying within the scale and adjusting octaves as needed.

Returns PitchScaleError::PitchClassOutOfScale if pitch is not a member of the scale.

pub fn chord_tone_to_scale_tone( chord_tone: usize, ) -> Result<usize, PitchScaleError>

Maps a one-based chord-tone index (root, third, fifth, …) to the one-based scale degree it occupies in tertian stacking.

pub fn scale_tone_to_diatonic(scale_tone: usize) -> Result<i32, PitchScaleError>

Maps a one-based scale degree to its zero-based diatonic step offset from the tonic.

Trait Implementations

impl Clone for Scale

fn clone(&self) -> Scale

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Scale

impl Debug for Scale

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

Formats the value using the given formatter.

impl Eq for Scale

impl Hash for Scale

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 Scale

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Scale