Struct music_theory::theory::chord::RelativeChord

pub struct RelativeChord {
    pub degree: ScaleDegree,
    pub chord: Chord,
}

Relative chord is a chord build not from a specific root note but a scale degree. Could be used for example to define chord progressions (eg. II -> V -> I).

Example:

use music_theory::theory::*;
assert_eq!(
    RelativeChord::new(ScaleDegree::I, MAJOR),
    RelativeChord{ degree: ScaleDegree::I, chord: Chord::new(MAJOR) }
);

Fields

degree: ScaleDegree

The degree from which the chord is buld.

chord: Chord

The quality of the chord.

Implementations

impl RelativeChord

pub fn new(degree: ScaleDegree, intervals: &[Note]) -> Self

Create a new RelativeChord from a ScaleDegree and the chord intervals.

Example:

use music_theory::theory::*;
let chord = RelativeChord::new(ScaleDegree::I, &MAJOR);
assert!(chord.chord.contains_all(&POWER));

pub fn from_chord(degree: ScaleDegree, chord: Chord) -> Self

Create a new ‘RelativeChord’ from a ScaleDegree and a chord.

Example:

use music_theory::theory::*;
let chord = RelativeChord::from_chord(ScaleDegree::I, Chord::new(&MAJOR_SEVENTH_CHORD));
assert!(chord.chord.contains_all(&MAJOR));

pub fn as_string(&self, style: ChordStyle) -> String

Stringify the RelativeChord.

Example:

use music_theory::theory::*;
let std = ChordStyle::Std(MStyle::Symbol, EStyle::Symbol);
assert_eq!(&RelativeChord::new(ScaleDegree::II, &MINOR_MAJOR_SEVENTH).as_string(std), "II-Δ");

pub fn to_rooted_chord_with_pc(self, tonic: PC) -> RootedChord

Convert to a RootedChord.

Example:

use music_theory::theory::*;
let rel_chord = RelativeChord::new(ScaleDegree::I, &MAJOR);
let root_chord = RootedChord::new(Note::C0, &MAJOR);
assert_eq!(rel_chord.to_rooted_chord_with_pc(PC::C), root_chord);

pub fn to_rooted_chord_with_note(self, tonic: Note) -> RootedChord

Convert to a RootedChord.

Example:

use music_theory::theory::*;
let rel_chord = RelativeChord::new(ScaleDegree::I, &MAJOR);
let root_chord = RootedChord::new(Note::C2, &MAJOR);
assert_eq!(rel_chord.to_rooted_chord_with_note(Note::C2), root_chord);

Trait Implementations

impl Clone for RelativeChord

fn clone(&self) -> RelativeChord

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RelativeChord

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

Formats the value using the given formatter.

impl Display for RelativeChord

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

Formats the value using the given formatter.

impl Hash for RelativeChord

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 Ord for RelativeChord

fn cmp(&self, other: &RelativeChord) -> 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<RelativeChord> for RelativeChord

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

fn partial_cmp(&self, other: &RelativeChord) -> 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 Eq for RelativeChord

impl StructuralEq for RelativeChord

impl StructuralPartialEq for RelativeChord