Struct Frets

pub struct Frets<const N: usize>(pub [Option<i16>; N]);

Represents fret positions on a string instrument.

This type stores the fret positions for each string, where None indicates a muted string and Some(fret_number) indicates which fret to press.

Example

use symphoxy::instrument_tools::strings::{GuitarTuning, GuitarFrets};
use symphoxy::prelude::*;
use symphoxy::scales::tet12::{A4, get_note_name};

// GuitarTuning is an alias for StringTuning<6>
let tuning = GuitarTuning::DEFAULT_GUITAR_TUNING;

let g_major_frets = GuitarFrets::new_full([3, 0, 0, 0, 2, 3]);

let g_major_chord = tuning.get_chord(&g_major_frets);

// Check each note is a G, B, or D
assert!(g_major_chord.0.into_iter().all(|pitch|
    get_note_name(pitch, A4) == "G" ||
    get_note_name(pitch, A4) == "B" ||
    get_note_name(pitch, A4) == "D"
));

Tuple Fields

0: [Option<i16>; N]

Implementations

impl<const N: usize> Frets<N>

pub fn new_full(frets: [i16; N]) -> Self

Creates a new fret configuration where all strings are fretted.

Takes an array of fret numbers and converts them to Some(fret) for each string. No strings will be muted with this constructor.

Examples

use symphoxy::instrument_tools::strings::*;

let all_fretted = GuitarFrets::new_full([3, 2, 0, 0, 3, 3]); // All strings active

impl Frets<6>

pub fn new_four_string(frets: [i16; 4]) -> Self

Creates a chord where the first four strings are specified and the last two are muted.

Trait Implementations

impl<const N: usize> Clone for Frets<N>

fn clone(&self) -> Frets<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for Frets<N>

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

Formats the value using the given formatter.

impl<const N: usize> From<[i16; N]> for Frets<N>

fn from(frets: [i16; N]) -> Self

Converts to this type from the input type.

impl<const N: usize> Hash for Frets<N>

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<const N: usize> PartialEq for Frets<N>

fn eq(&self, other: &Frets<N>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<const N: usize> Copy for Frets<N>

impl<const N: usize> Eq for Frets<N>

impl<const N: usize> StructuralPartialEq for Frets<N>