Struct redact_composer_musical::Chord

pub struct Chord { /* private fields */ }

Describes a chord using a root PitchClass, and ChordShape.

use redact_composer_musical::{Chord, ChordShape::maj7, PitchClassCollection, NoteName::*};

assert_eq!(Chord::from((C, maj7)).pitch_classes(), [C, E, G, B]);

Implementations

impl Chord

pub fn new<R: Into<PitchClass>>(root: R, shape: ChordShape) -> Chord

Constructs a Chord from a root and interval collection.

pub fn is_in_key(&self, key: &Key) -> bool

Checks if this chord contains notes exclusively from a particular key.

pub fn root(&self) -> PitchClass

Returns the root PitchClass of this chord.

pub fn shape(&self) -> ChordShape

Returns the ChordShape of this chord. (e.g. maj, min…)

pub fn contains<P: PitchClassCollection>(&self, pitches: &P) -> bool

Checks if all PitchClasss from a collection belong to this Chord.

use redact_composer_musical::{Chord, ChordShape::maj, NoteName::*};

assert!(Chord::from((C, maj)).contains(&[C, E, G]));

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<R> From<(R, ChordShape)> for Chord

where R: Into<PitchClass>,

fn from(value: (R, ChordShape)) -> Self

Converts to this type from the input type.

impl IntervalCollection for Chord

fn intervals(&self) -> Vec<Interval>

Provides a collection of intervals, each as an absolute interval from a relative pitch.

impl NoteIterator for Chord

fn iter_notes_in_range<R: RangeBounds<Note>>( &self, note_range: R ) -> NoteIter<R>

Returns a note iterator (NoteIter) for notes of an interval pattern within the given note range.

fn notes_in_range<R: RangeBounds<Note>>(&self, note_range: R) -> Vec<Note>

Returns all notes matching an interval pattern within the given note range.

impl PartialEq 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: &Rhs) -> bool

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

impl PitchClassCollection for Chord

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

Returns this type’s pitches.

impl Copy for Chord

impl Eq for Chord

impl StructuralPartialEq for Chord