Struct Pitch

#[repr(transparent)]
pub struct Pitch(pub PitchTy);

A pitch is a discrete tone with an individual frequency that may be classified as a pitch class.

Tuple Fields

0: PitchTy

Implementations

impl Pitch

pub const MOD: PitchTy = 12i8

pub fn new(pitch: PitchTy) -> Self

pub fn into_inner(self) -> PitchTy

Consumes the object, returning the assigned pitch value.

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

A functional accessor for the pitch value.

pub fn get_mut(&mut self) -> &mut PitchTy

returns a mutable reference to the inner value of the pitch;

pub fn set(&mut self, val: PitchTy)

A functional mutator for the pitch value.

impl Pitch

pub fn class(&self) -> Pitches

Returns a new instance of the class representing the given pitch.

pub fn into_class(self) -> Pitches

Consumes the pitch; returns a new instance of the class representing the given pitch.

pub fn map<F>(self, f: F) -> Self

where F: Fn(PitchTy) -> PitchTy,

pub fn map_mut<F>(&mut self, f: F)

where F: FnMut(&mut PitchTy),

pub fn map_once<F>(self, f: F) -> Self

where F: FnOnce(PitchTy) -> PitchTy,

Consumes the current instance and applies the given function to the pitch value, returning a new instance of Pitch.

pub fn abs(self) -> Self

Consumes the current instance and computes the absolute value of the pitch, returning a new instance of Pitch.

pub fn absmod(self) -> Self

Returns the absolute value of the remainder of the pitch divided by the modulus.

pub fn pymod(self) -> Self

The octmod method computes the modulus of the current pitch using Python’s modulo operator, %. This method is useful for pitch arithmetic due to its unique sign-handling behavior.

impl Pitch

pub fn add_interval<T>(&self, rhs: T) -> Self

where i8: Add<T, Output = PitchTy>,

pub fn div_interval<T>(&self, rhs: T) -> Self

where i8: Div<T, Output = PitchTy>,

pub fn mul_interval<T>(&self, rhs: T) -> Self

where i8: Mul<T, Output = PitchTy>,

pub fn rem_interval<T>(&self, rhs: T) -> Self

where i8: Rem<T, Output = PitchTy>,

pub fn sub_interval<T>(&self, rhs: T) -> Self

where i8: Sub<T, Output = PitchTy>,

Methods from Deref<Target = PitchTy>

pub const MIN: i8 = -128i8

pub const MAX: i8 = 127i8

pub const BITS: u32 = 8u32

Trait Implementations

impl<'a> Add<&'a Pitch> for Pitch

type Output = Pitch

The resulting type after applying the + operator.

fn add(self, rhs: &'a Pitch) -> Self::Output

Performs the + operation.

impl<'a> Add<Pitch> for &'a Pitch

type Output = Pitch

The resulting type after applying the + operator.

fn add(self, rhs: Pitch) -> Self::Output

Performs the + operation.

impl<'a, T> Add<T> for &'a Pitch

where PitchTy: Add<T, Output = PitchTy>,

type Output = Pitch

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Self::Output

Performs the + operation.

impl<T> Add<T> for Pitch

where PitchTy: Add<T, Output = PitchTy>,

type Output = Pitch

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Self::Output

Performs the + operation.

impl<'a> Add for &'a Pitch

type Output = Pitch

The resulting type after applying the + operator.

fn add(self, rhs: &'a Pitch) -> Self::Output

Performs the + operation.

impl Add for Pitch

type Output = Pitch

The resulting type after applying the + operator.

fn add(self, rhs: Pitch) -> Self::Output

Performs the + operation.

impl AsMut<i8> for Pitch

fn as_mut(&mut self) -> &mut PitchTy

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

impl AsRef<i8> for Pitch

fn as_ref(&self) -> &PitchTy

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

impl Binary for Pitch

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

Formats the value using the given formatter.

impl Borrow<i8> for Pitch

fn borrow(&self) -> &PitchTy

Immutably borrows from an owned value.

impl BorrowMut<i8> for Pitch

fn borrow_mut(&mut self) -> &mut PitchTy

Mutably borrows from an owned value.

impl Clone for Pitch

fn clone(&self) -> Pitch

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Pitch

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

Formats the value using the given formatter.

impl Default for Pitch

fn default() -> Self

Returns the “default value” for a type.

impl DerefMut for Pitch

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for Pitch

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Pitch

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

Formats the value using the given formatter.

impl<'a> Div<&'a Pitch> for Pitch

type Output = Pitch

The resulting type after applying the / operator.

fn div(self, rhs: &'a Pitch) -> Self::Output

Performs the / operation.

impl<'a> Div<Pitch> for &'a Pitch

type Output = Pitch

The resulting type after applying the / operator.

fn div(self, rhs: Pitch) -> Self::Output

Performs the / operation.

impl<'a, T> Div<T> for &'a Pitch

where PitchTy: Div<T, Output = PitchTy>,

type Output = Pitch

The resulting type after applying the / operator.

fn div(self, rhs: T) -> Self::Output

Performs the / operation.

impl<T> Div<T> for Pitch

where PitchTy: Div<T, Output = PitchTy>,

type Output = Pitch

The resulting type after applying the / operator.

fn div(self, rhs: T) -> Self::Output

Performs the / operation.

impl<'a> Div for &'a Pitch

type Output = Pitch

The resulting type after applying the / operator.

fn div(self, rhs: &'a Pitch) -> Self::Output

Performs the / operation.

impl Div for Pitch

type Output = Pitch

The resulting type after applying the / operator.

fn div(self, rhs: Pitch) -> Self::Output

Performs the / operation.

impl From<Flat> for Pitch

fn from(pitch: Flat) -> Pitch

Converts to this type from the input type.

impl From<Natural> for Pitch

fn from(pitch: Natural) -> Pitch

Converts to this type from the input type.

impl From<Note> for Pitch

fn from(note: Note) -> Self

Converts to this type from the input type.

impl From<Pitch> for Note

fn from(pitch: Pitch) -> Self

Converts to this type from the input type.

impl From<Pitch> for Pitches

fn from(pitch: Pitch) -> Self

Converts to this type from the input type.

impl From<Pitch> for PitchTy

fn from(pitch: Pitch) -> Self

Converts to this type from the input type.

impl From<Pitches> for Pitch

fn from(pitch: Pitches) -> Self

Converts to this type from the input type.

impl From<Sharp> for Pitch

fn from(pitch: Sharp) -> Pitch

Converts to this type from the input type.

impl From<i8> for Pitch

fn from(pitch: PitchTy) -> Self

Converts to this type from the input type.

impl Hash for Pitch

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 LowerHex for Pitch

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

Formats the value using the given formatter.

impl<'a> Mul<&'a Pitch> for Pitch

type Output = Pitch

The resulting type after applying the * operator.

fn mul(self, rhs: &'a Pitch) -> Self::Output

Performs the * operation.

impl<'a> Mul<Pitch> for &'a Pitch

type Output = Pitch

The resulting type after applying the * operator.

fn mul(self, rhs: Pitch) -> Self::Output

Performs the * operation.

impl<'a, T> Mul<T> for &'a Pitch

where PitchTy: Mul<T, Output = PitchTy>,

type Output = Pitch

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> Self::Output

Performs the * operation.

impl<T> Mul<T> for Pitch

where PitchTy: Mul<T, Output = PitchTy>,

type Output = Pitch

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> Self::Output

Performs the * operation.

impl<'a> Mul for &'a Pitch

type Output = Pitch

The resulting type after applying the * operator.

fn mul(self, rhs: &'a Pitch) -> Self::Output

Performs the * operation.

impl Mul for Pitch

type Output = Pitch

The resulting type after applying the * operator.

fn mul(self, rhs: Pitch) -> Self::Output

Performs the * operation.

impl<'a> Neg for &'a Pitch

type Output = Pitch

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Neg for Pitch

type Output = Pitch

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<'a> Not for &'a Pitch

type Output = Pitch

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Not for Pitch

type Output = Pitch

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Notable for Pitch

fn pitch_class(&self) -> Pitches

Classify the pitch into a pitch class

fn pitch(&self) -> Pitch

Find the modular index of the given pitch

impl Num for Pitch

type FromStrRadixErr = <i8 as Num>::FromStrRadixErr

fn from_str_radix(s: &str, radix: u32) -> Result<Self, Self::FromStrRadixErr>

Convert from a string and radix (typically 2..=36).

impl Octal for Pitch

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

Formats the value using the given formatter.

impl One for Pitch

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool

where Self: PartialEq,

Returns true if self is equal to the multiplicative identity.

impl Ord for Pitch

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

fn eq(&self, other: &Pitch) -> 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 PartialOrd for Pitch

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

type Output = Pitch

fn pitchmod(&self) -> Self::Output

const MOD: PitchTy = 12i8

impl<'a> Rem<&'a Pitch> for Pitch

type Output = Pitch

The resulting type after applying the % operator.

fn rem(self, rhs: &'a Pitch) -> Self::Output

Performs the % operation.

impl<'a> Rem<Pitch> for &'a Pitch

type Output = Pitch

The resulting type after applying the % operator.

fn rem(self, rhs: Pitch) -> Self::Output

Performs the % operation.

impl<'a, T> Rem<T> for &'a Pitch

where PitchTy: Rem<T, Output = PitchTy>,

type Output = Pitch

The resulting type after applying the % operator.

fn rem(self, rhs: T) -> Self::Output

Performs the % operation.

impl<T> Rem<T> for Pitch

where PitchTy: Rem<T, Output = PitchTy>,

type Output = Pitch

The resulting type after applying the % operator.

fn rem(self, rhs: T) -> Self::Output

Performs the % operation.

impl<'a> Rem for &'a Pitch

type Output = Pitch

The resulting type after applying the % operator.

fn rem(self, rhs: &'a Pitch) -> Self::Output

Performs the % operation.

impl Rem for Pitch

type Output = Pitch

The resulting type after applying the % operator.

fn rem(self, rhs: Pitch) -> Self::Output

Performs the % operation.

impl Serialize for Pitch

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Sub<&'a Pitch> for Pitch

type Output = Pitch

The resulting type after applying the - operator.

fn sub(self, rhs: &'a Pitch) -> Self::Output

Performs the - operation.

impl<'a> Sub<Pitch> for &'a Pitch

type Output = Pitch

The resulting type after applying the - operator.

fn sub(self, rhs: Pitch) -> Self::Output

Performs the - operation.

impl<'a, T> Sub<T> for &'a Pitch

where PitchTy: Sub<T, Output = PitchTy>,

type Output = Pitch

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> Self::Output

Performs the - operation.

impl<T> Sub<T> for Pitch

where PitchTy: Sub<T, Output = PitchTy>,

type Output = Pitch

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> Self::Output

Performs the - operation.

impl<'a> Sub for &'a Pitch

type Output = Pitch

The resulting type after applying the - operator.

fn sub(self, rhs: &'a Pitch) -> Self::Output

Performs the - operation.

impl Sub for Pitch

type Output = Pitch

The resulting type after applying the - operator.

fn sub(self, rhs: Pitch) -> Self::Output

Performs the - operation.

impl TryFrom<Pitch> for Fifth

type Error = Error

The type returned in the event of a conversion error.

fn try_from(interval: Pitch) -> Result<Fifth, Self::Error>

Performs the conversion.

impl TryFrom<Pitch> for Flat

type Error = Error

The type returned in the event of a conversion error.

fn try_from(p: Pitch) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Pitch> for Fourth

type Error = Error

The type returned in the event of a conversion error.

fn try_from(interval: Pitch) -> Result<Fourth, Self::Error>

Performs the conversion.

impl TryFrom<Pitch> for Natural

type Error = Error

The type returned in the event of a conversion error.

fn try_from(p: Pitch) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Pitch> for Seventh

type Error = Error

The type returned in the event of a conversion error.

fn try_from(interval: Pitch) -> Result<Seventh, Self::Error>

Performs the conversion.

impl TryFrom<Pitch> for Sharp

type Error = Error

The type returned in the event of a conversion error.

fn try_from(p: Pitch) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Pitch> for Third

type Error = Error

The type returned in the event of a conversion error.

fn try_from(interval: Pitch) -> Result<Third, Self::Error>

Performs the conversion.

impl UpperHex for Pitch

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

Formats the value using the given formatter.

impl Zero for Pitch

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl Deref for Pitch

type Target = i8

The resulting type after dereferencing.

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

Dereferences the value.

impl Copy for Pitch

impl Eq for Pitch

impl StructuralPartialEq for Pitch