Struct tonal::Chord

pub struct Chord { /* fields omitted */ }

Represents a pitch or group of pitches with shared volume and length.

The reason both chords and single notes are represented by the same strcut is because I don't know of a better way of doing it without duplicating code.

Implementations

impl Chord

pub fn new(pitches: Vec<Pitch>, length: Length, volume: f64) -> Self

Creates a new chord.

pub fn new_major(root: Pitch, length: Length, volume: f64) -> Self

Creates a new major chord based off of the root.

This will construct a major chord by including the root, the pitch a major third above it, and the pitch a perfect fifth above it.

Examples

use tonal::*;

let c4 = Pitch::new(Name::C, 4);
let c_maj = Chord::new_major(c4, Length::Whole, 0.5);
let correct = [c4, Pitch::new(Name::E, 4), Pitch::new(Name::G, 4)];
assert_eq!(c_maj.pitches(), &correct);

pub fn pitches(&self) -> &[Pitch]

Allows access to the pitches in this chord.

pub fn pitches_mut(&mut self) -> &mut Vec<Pitch>

Allows mutable access to the pitches in this chord.

pub fn samples(&self, bpm: f64, rate: u32) -> Samples

Returns an iterator of PCM samples representing this chord.

This is mostly useful for music playback.

Trait Implementations

impl Clone for Chord

fn clone(&self) -> Chord

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

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for Chord