Struct BitChord 

pub struct BitChord {
    pub mask: PitchClassMask,
    pub root: Option<PitchClass>,
}

A chord represented as a PitchClassMask with an optional designated root.

When root is None the chord is rootless and can be reduced to its transposition-invariant normal form via BitChord::canonical.

Fields

mask: PitchClassMask

The pitch classes that make up the chord.

root: Option<PitchClass>

The chord root, or None for a rootless chord.

Implementations

impl BitChord

pub fn canonical(self) -> Self

Returns a canonical form: rooted chords are returned unchanged, while rootless chords are normalized to their lowest-valued rotation.

Trait Implementations

impl Clone for BitChord

fn clone(&self) -> BitChord

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BitChord

impl Debug for BitChord

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

Formats the value using the given formatter.

impl Eq for BitChord

impl Hash for BitChord

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 PartialEq for BitChord

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for BitChord