Struct Chord 

pub struct Chord {
    pub notes: Vec<Note>,
}

A chord is a collection of notes that are played simultaneously for the same duration.

Fields

notes: Vec<Note>

Implementations

impl Chord

pub const fn new(notes: Vec<Note>) -> Self

Creates a new chord with the given notes.

pub fn single(note: Note) -> Self

Creates a new chord with the single note provided.

pub fn rotate(&self) -> Self

pub fn rotate_by(&self, n: usize) -> Self

pub fn triad_from_root( tonality: Tonality, root: Note, inversion: Inversion, ) -> Self

Creates a trait with a given tonality, root, and inversion.

Examples

use note_pen::prelude::*;
let chord = Chord::triad_from_root(Tonality::Major, Note::new(Alphabet::C, Accidental::Natural, 4), Inversion::ROOT);
assert_eq!(chord, Note::new(Alphabet::C, Accidental::Natural, 4) +
  Note::new(Alphabet::E, Accidental::Natural, 4) +
 Note::new(Alphabet::G, Accidental::Natural, 4)
);

pub fn triad_from_base( tonality: Tonality, base: Note, inversion: Inversion, ) -> Self

Creates a triad with a given tonality, base, and inversion.

Examples

use note_pen::prelude::*;
let chord = Chord::triad_from_base(Tonality::Major, Note::new(Alphabet::E, Accidental::Natural, 4), Inversion::ROOT);
assert_eq!(chord, Note::new(Alphabet::E, Accidental::Natural, 4) +
 Note::new(Alphabet::G, Accidental::Sharp, 4) +
Note::new(Alphabet::B, Accidental::Natural, 5)
);

Trait Implementations

impl Add<Note> for Chord

type Output = Chord

The resulting type after applying the + operator.

fn add(self, note: Note) -> Chord

Performs the + operation.

impl Clone for Chord

fn clone(&self) -> Chord

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Chord

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

Formats the value using the given formatter.

impl PartialEq for Chord

fn eq(&self, other: &Self) -> 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.