Struct Pitch 

#[repr(C)]
pub struct Pitch<T = f32> { /* private fields */ }

A discrete pitch with a class and frequency.

Implementations

impl<T> Pitch<T>

where T: RawFrequency,

pub fn new(class: usize, freq: Frequency<T>) -> Self

pub const fn class(&self) -> usize

returns a copy to the index of the note’s class

pub fn class_mut(&mut self) -> &mut usize

returns a mutable reference to the index of the note’s class

pub const fn frequency(&self) -> &Frequency<T>

returns a reference to the frequency of the pitch

pub const fn frequency_mut(&mut self) -> &mut Frequency<T>

returns a mutable reference to the current octave

pub fn set_class(&mut self, class: usize) -> &mut Self

set the pitch class and return a mutable reference to the current instance

pub fn set_frequency(&mut self, freq: Frequency<T>) -> &mut Self

set the frequency and return a mutable reference to the current instance

pub fn with_class(self, class: usize) -> Self

consumes the current instance to create another with the given pitch class

pub fn with_frequency<T2>(self, freq: Frequency<T2>) -> Pitch<T2>

where T2: RawFrequency,

consumes the current instance to create another with the given frequency

Trait Implementations

impl<T: Clone> Clone for Pitch<T>

fn clone(&self) -> Pitch<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Pitch<T>

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

Formats the value using the given formatter.

impl<T> Default for Pitch<T>

where T: Default,

fn default() -> Self

Returns the “default value” for a type.

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

where T: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Display for Pitch<T>

where T: RawFrequency,

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

Formats the value using the given formatter.

impl<T: Hash> Hash for Pitch<T>

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<T: Ord> Ord for Pitch<T>

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

where T: RawFrequency + PartialEq,

fn eq(&self, other: &Frequency<T>) -> 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<T> PartialEq<Pitch<T>> for usize

where T: RawFrequency,

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

where T: RawFrequency,

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

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

where T: RawFrequency,

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

where T: RawFrequency,

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

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

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Copy> Copy for Pitch<T>

impl<T: Eq> Eq for Pitch<T>

impl<T> StructuralPartialEq for Pitch<T>