Struct Scale 

pub struct Scale { /* private fields */ }

A named scale realized from a tonic pitch.

use music21_rs::{Pitch, Scale, ScaleType};

let scale = Scale::new(ScaleType::Octatonic, Pitch::from_name("C4")?);
let names: Vec<String> = scale.pitches()?.iter().map(|p| p.name()).collect();

assert_eq!(names, ["C", "D", "E-", "F", "G-", "A-", "A", "B", "C"]);

Implementations

impl Scale

pub fn new(scale_type: ScaleType, tonic: Pitch) -> Self

Builds a scale of the given type on a tonic.

pub fn scale_type(&self) -> ScaleType

Returns the scale type.

pub fn tonic(&self) -> &Pitch

Returns the tonic pitch.

pub fn pitches(&self) -> Result<Vec<Pitch>>

Returns the pitches of one octave, from the tonic through its octave.

The result has degree_count() + 1 entries, since the closing octave is included the way music21’s getPitches includes it.

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

Returns the pitch at a one-based scale degree.

Degree 1 is the tonic and degree_count() + 1 is the octave above it. Degrees beyond that continue into higher octaves.

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 Debug for Scale

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

Formats the value using the given formatter.

impl PartialEq for Scale

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Scale