Struct PitchClass 

pub struct PitchClass(/* private fields */);

A mod-12 pitch class, where C = 0 and values increase by semitone to B = 11.

Pitch classes are octave-agnostic: every C, regardless of register, shares the pitch class C. The inner u8 is always in the range 0..12.

Examples

use sim_lib_pitch_core::PitchClass;

assert_eq!(PitchClass::C.transpose(7), PitchClass::G);
assert_eq!(PitchClass::E.interval_class(PitchClass::C), 4);

Implementations

impl PitchClass

pub const C: Self

The pitch class C (0).

pub const CS: Self

The pitch class C-sharp / D-flat (1).

pub const D: Self

The pitch class D (2).

pub const DS: Self

The pitch class D-sharp / E-flat (3).

pub const E: Self

The pitch class E (4).

pub const F: Self

The pitch class F (5).

pub const FS: Self

The pitch class F-sharp / G-flat (6).

pub const G: Self

The pitch class G (7).

pub const GS: Self

The pitch class G-sharp / A-flat (8).

pub const A: Self

The pitch class A (9).

pub const AS: Self

The pitch class A-sharp / B-flat (10).

pub const B: Self

The pitch class B (11).

pub fn new(value: u8) -> Result<Self, PitchError>

Constructs a pitch class from a raw value, rejecting values of 12 or more.

pub const fn value(self) -> u8

Returns the raw mod-12 pitch-class value.

pub fn transpose(self, semitones: i32) -> Self

Returns this pitch class shifted up by semitones (or down if negative), wrapping within the mod-12 octave.

pub fn invert(self, axis: PitchClass) -> Self

Returns the inversion of this pitch class about axis, wrapping within the mod-12 octave.

pub fn interval_class(self, other: PitchClass) -> u8

Returns the interval class (0..=6) between this pitch class and other, the smaller of the ascending and descending distances.

pub fn canonical_name(self) -> &'static str

Returns the canonical sharp-spelled name of this pitch class (for example "C#" for pitch class 1).

Trait Implementations

impl Clone for PitchClass

fn clone(&self) -> PitchClass

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PitchClass

impl Debug for PitchClass

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

Formats the value using the given formatter.

impl Eq for PitchClass

impl Hash for PitchClass

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 PitchClass

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for PitchClass

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