Struct music_theory::theory::scale::Scale

pub struct Scale(_);

A scale is a list of notes. For example, the C2 Major scale contains the notes [C2, D2, E2, F2, G2, A3, B3].

Example:

use music_theory::theory::*;
let scale = Scale::wrap(
    vec![Note::C1, Note::D1, Note::E1, Note::F1, Note::G1, Note::A2, Note::B2]
).unwrap();
assert!(scale.contains_all(&[Note::E1, Note::A2]));

Implementations

impl Scale

pub fn as_octave_steps(&self) -> Option<Steps>

Will try to convert the scale to steps that define an octave scale. This means it needs to fit into one octave. It will add a last step so the steps wrap back onto the first note.

Example:

use music_theory::theory::*;
let W = Interval::WHOLE;
let H = Interval::SEMI;
assert_eq!( // C Major
    Scale::wrap(vec![Note::C1, Note::D1, Note::E1, Note::F1, Note::G1, Note::A2, Note::B2])
        .unwrap().as_octave_steps(),
    Steps::wrap(vec![W, W, H, W, W, W, H])
);

Trait Implementations

impl AsChord for Scale

fn as_chord(&self) -> Chord

Borrow self and return a Chord.

impl AsEnharmonicNotes for Scale

fn as_enharmonic_notes(&self) -> Vec<EnharmonicNote>

Borrow self and return a vector of EnharmonicNote.

impl AsEnharmonicNotesWithStart for Scale

fn as_enharmonic_notes_with_start( &self, start: Option<EnharmonicNote> ) -> Vec<EnharmonicNote>

Borrow self and return a vector of EnharmonicNote. You can optionally specify a starting note. This will affect the spelling. Subsequent notes will be spelled with subsequent letters.

impl AsPCs for Scale

fn as_pcs(&self) -> PCs

Borrow self and return PCs.

impl AsRootedChord for Scale

fn as_rooted_chord(&self) -> RootedChord

Borrow self and return a RootedChord.

impl AsSteps for Scale

fn as_steps(&self, complete_octave_cycle: bool) -> Steps

Borrow self and return Steps. complete_octave_cycle instructs whether the steps should wrap around the starting note to complete the octave.

impl AsSubs for Scale

fn as_subs(&self, max_len: Option<usize>) -> Vec<Self>

Generate all subs sets with optional maximal subset length. The output size of this grows really fast with the input size so be aware: 2, 5, 16, 65, 326, 1957, 13700, 109601, 986410, 9864101, 108505112.

impl Clone for Scale

fn clone(&self) -> Scale

Returns a copy 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 Default for Scale

fn default() -> Scale

Returns the “default value” for a type.

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 Index<usize> for Scale

type Output = Note

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Scale

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl ModeTrait for Scale

fn next_mode_mut(&mut self)

Modify the value so it turns into it’s next mode.

fn next_mode(self) -> Self

Take the value and give back it’s next mode.

fn mode(self, mode: Mode) -> Self

Take the value and give back it’s Nth mode.

impl Ord for Scale

fn cmp(&self, other: &Scale) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Scale> for Scale

fn eq(&self, other: &Scale) -> 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 PartialOrd<Scale> for Scale

fn partial_cmp(&self, other: &Scale) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl VecWrapper for Scale

type Item = Note

The type the new type wraps.

fn len(&self) -> usize

Return the length of the inner vector.

fn is_empty(&self) -> bool

Return whether the inner vector is empty or not.

fn iter(&self) -> Iter<'_, Self::Item>

Iterate over the inner vector.

fn contains(&self, item: &Self::Item) -> bool

Returns whether the inner vector contains an item.

fn contains_all(&self, items: &[Self::Item]) -> bool

Returns whether the inner vector contains all of the given items.

fn contains_any(&self, items: &[Self::Item]) -> bool

Returns whether the inner vector contains any of the given items.

impl Wrapper for Scale

type Inner = Vec<Note, Global>

The type the new type wraps.

fn wrap(scale: Self::Inner) -> Option<Self>

Try to wrap a Self::Inner type into the Self type.

fn unwrap(self) -> Self::Inner

Unwrap a Self type into a Self::Inner type.

impl Eq for Scale

impl StructuralEq for Scale

impl StructuralPartialEq for Scale