Struct PitchClass 

pub struct PitchClass<P = CNote, K = <P as RawPitchClass>::Tag>
where
    P: RawPitchClass<Tag = K>,
    K: RawAccidental,
{ /* private fields */ }

The PitchClass implementations works to generically define the structure for a pitch class. This is accomplished through the use of two type parameters: N, which defines the note (e.g., C, D, E, etc.), and K, which defines the kind of pitch (e.g., sharp, flat, natural, etc.).

Note: This struct isn’t designed to be used directly, rather through type aliases such as C, DSharp, EFlat, etc.

Implementations

impl<P, K> PitchClass<P, K>

where P: RawPitchClass<Tag = K>, K: RawAccidental,

pub fn new() -> Self

where P: Default, K: Default,

pub fn from_class(class: P) -> Self

where K: Default,

pub const fn as_ptr(&self) -> *const P

returns a pointer to the class

pub const fn as_mut_ptr(&mut self) -> *mut P

returns a mutable pointer to the class

pub fn as_frequency<T>(&self) -> Frequency<T>

where P: RawPitchClass<Tag = K>, K: RawAccidental, T: RawFrequency + Float + FromPrimitive,

convert the pitch class into a Frequency based on the standard A4 tuning

pub const fn get(&self) -> &P

returns a reference to the defined class

pub const fn get_mut(&mut self) -> &mut P

returns a mutable reference to the defined class

pub fn is_natural(&self) -> bool

where K: 'static,

returns true if the class is considered natural

pub fn is_flat(&self) -> bool

where K: 'static,

returns true if the class is considered flat

pub fn is_sharp(&self) -> bool

where K: 'static,

returns true if the class is considered sharp

impl<N> PitchClass<N>

where N: RawPitchClass,

pub const fn natural(class: N) -> PitchClass<N, Natural>

where N: RawPitchClass<Tag = Natural>,

initialize a new, natural pitch class

pub const fn sharp(class: N) -> PitchClass<N, Sharp>

where N: RawPitchClass<Tag = Sharp>,

initialize a sharp instance of the given class

pub const fn flat(class: N) -> PitchClass<N, Flat>

where N: RawPitchClass<Tag = Flat>,

initialize a flat instance of the given class

Trait Implementations

impl<T1, A1, T2, A2> Add<PitchClass<T2, A2>> for PitchClass<T1, A1>

where T1: RawPitchClass<Tag = A1>, A1: RawAccidental, T2: RawPitchClass<Tag = A2>, A2: RawAccidental,

Add two pitch-classes producing a wrapped semitone count in the tonal space.

Note: returning a compile-time PitchClass subtype from an operator requires a type-level index; that’s not possible for arbitrary runtime sums. We therefore return an i32 semitone value (0..11) using PitchMod::pmod. Callers can convert that numeric result into any runtime/compile-time representation they prefer.

type Output = isize

The resulting type after applying the + operator.

fn add(self, rhs: PitchClass<T2, A2>) -> Self::Output

Performs the + operation.

impl<P, K> AsRef<isize> for PitchClass<P, K>

where P: RawPitchClass<Tag = K>, K: RawAccidental,

fn as_ref(&self) -> &isize

Converts this type into a shared reference of the (usually inferred) input type.

impl<P, K> AsRef<str> for PitchClass<P, K>

where P: RawPitchClass<Tag = K>, K: RawAccidental,

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl<P, K> Borrow<isize> for PitchClass<P, K>

where P: RawPitchClass<Tag = K>, K: RawAccidental,

fn borrow(&self) -> &isize

Immutably borrows from an owned value.

impl<P, K> Clone for PitchClass<P, K>

where P: RawPitchClass<Tag = K> + Clone, K: RawAccidental + Clone,

fn clone(&self) -> PitchClass<P, K>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P, K> Debug for PitchClass<P, K>

where P: RawPitchClass<Tag = K>, K: RawAccidental,

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

Formats the value using the given formatter.

impl<P, K> Default for PitchClass<P, K>

where P: RawPitchClass<Tag = K> + Default, K: RawAccidental + Default,

fn default() -> PitchClass<P, K>

Returns the “default value” for a type.

impl<P, K> Deref for PitchClass<P, K>

where P: RawPitchClass<Tag = K>, K: RawAccidental,

type Target = P

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<P, K> Display for PitchClass<P, K>

where P: RawPitchClass<Tag = K>, K: RawAccidental,

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

Formats the value using the given formatter.

impl<P, K> FromStr for PitchClass<P, K>

where P: PitchClassRepr<Tag = K>, K: Accidental,

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<P, K> Hash for PitchClass<P, K>

where P: RawPitchClass<Tag = K> + Hash, K: RawAccidental + Hash,

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<P, K> Ord for PitchClass<P, K>

where P: RawPitchClass<Tag = K> + Ord, K: RawAccidental + Ord,

fn cmp(&self, other: &PitchClass<P, K>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<P, K> PartialEq<PitchClass<P, K>> for isize

where P: RawPitchClass<Tag = K>, K: RawAccidental,

fn eq(&self, other: &PitchClass<P, K>) -> bool

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

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<P, K> PartialEq<isize> for PitchClass<P, K>

where P: RawPitchClass<Tag = K>, K: RawAccidental,

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

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

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<P, K> PartialEq for PitchClass<P, K>

where P: RawPitchClass<Tag = K> + PartialEq, K: RawAccidental + PartialEq,

fn eq(&self, other: &PitchClass<P, K>) -> bool

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

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<P, K> PartialOrd for PitchClass<P, K>

where P: RawPitchClass<Tag = K> + PartialOrd, K: RawAccidental + PartialOrd,

fn partial_cmp(&self, other: &PitchClass<P, K>) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T1, A1, T2, A2> Sub<PitchClass<T2, A2>> for PitchClass<T1, A1>

where T1: RawPitchClass<Tag = A1>, A1: RawAccidental, T2: RawPitchClass<Tag = A2>, A2: RawAccidental,

type Output = isize

Subtract two pitch-classes producing a wrapped signed semitone interval.

fn sub(self, rhs: PitchClass<T2, A2>) -> Self::Output

Performs the - operation.

impl<P, K> TryFrom<isize> for PitchClass<P, K>

where P: PitchClassRepr<Tag = K>, K: Accidental,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: isize) -> Result<Self, Self::Error>

Performs the conversion.

impl<P, K> Copy for PitchClass<P, K>

where P: RawPitchClass<Tag = K> + Copy, K: RawAccidental + Copy,

impl<P, K> Eq for PitchClass<P, K>

where P: RawPitchClass<Tag = K> + Eq, K: RawAccidental + Eq,

impl<P, K> Send for PitchClass<P, K>

where P: RawPitchClass<Tag = K>, K: RawAccidental,

impl<P, K> StructuralPartialEq for PitchClass<P, K>

where P: RawPitchClass<Tag = K>, K: RawAccidental,

impl<P, K> Sync for PitchClass<P, K>

where P: RawPitchClass<Tag = K>, K: RawAccidental,