Struct ukebox::voicing::Voicing

pub struct Voicing { /* fields omitted */ }

Implementations

impl Voicing

The voicing of a chord describes the order of the individual notes within the chord. The same chord can be voiced in different ways, i.e. there are several ways to play the same chord on the ukulele. https://en.wikipedia.org/wiki/Voicing_(music)

pub fn new(fret_pattern: impl Into<FretPattern>, tuning: Tuning) -> Self

pub fn uke_strings(&self) -> Iter<'_, UkeString>

pub fn roots(&self) -> impl Iterator<Item = Note> + '_

pub fn frets(&self) -> impl Iterator<Item = FretID> + '_

pub fn notes(&self) -> impl Iterator<Item = Note> + '_

pub fn count_pressed_strings(&self) -> usize

Return the overall number of strings pressed down when playing this voicing.

pub fn get_min_pressed_fret(&self) -> FretID

Return the lowest fret at which a string is pressed down.

pub fn get_min_fret(&self) -> FretID

Return the lowest fret involved in playing the chord voicing (is 0 if the chord is open).

pub fn get_max_fret(&self) -> FretID

pub fn get_span(&self) -> FretID

pub fn spells_out(&self, chord: &Chord) -> bool

Return true if the voicing contains all the notes needed to play the given chord.

pub fn get_chords(&self) -> Vec<Chord>

pub fn has_barre(&self) -> bool

Return true if the current voicing requires the player to play a barre chord. For this, I took some inspiration from https://github.com/hyvyys/chord-fingering/blob/master/src/barre.js

pub fn fingers_on_strings(&self) -> [u8; 4]

Compute a fingering for the current voicing, i.e. assign the player’s fingers to the positions on the fretboard that have to be pressed down. The return value is an array of numbers representing the fingers on the strings (represented by the indexes of the array). This assumes that each chord voicing has a unique fingering (which is not true in reality - often several fingerings are possible). My fingering strategy here is based on my own way to play certain chords. For example, I tend to avoid barre chords if possible, e.g. I play the G major chord as 0132 and not as 0121.

pub fn semitone_distance(&self, other: Voicing) -> u8

Return the distance in semitones between this and another voicing. It’s computed by simply summing up the distances between the frets that are pressed down on the same string when moving from one voicing to the other. Inspired by http://www.petecorey.com/blog/2018/07/30/voice-leading-with-elixir/

pub fn fingering_distance(&self, other: Voicing) -> u8

pub fn distance(&self, other: Voicing) -> Distance

Trait Implementations

impl Clone for Voicing

fn clone(&self) -> Voicing

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Voicing

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

Formats the value using the given formatter.

impl Default for Voicing

The default implementation is used to easily create an “empty” start and end node in the voicing graph.

fn default() -> Self

Returns the “default value” for a type.

impl From<&'_ [(Note, u8, Note)]> for Voicing

fn from(uke_strings: &[UkeString]) -> Self

Performs the conversion.

impl From<Voicing> for Fingering

fn from(voicing: Voicing) -> Self

Performs the conversion.

impl Ord for Voicing

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Voicing> for Voicing

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

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

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

This method tests for !=.

impl PartialOrd<Voicing> for Voicing

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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 Copy for Voicing

impl Eq for Voicing

impl StructuralEq for Voicing

impl StructuralPartialEq for Voicing