Struct Frequency 

#[repr(transparent)]
pub struct Frequency<T = f64>(pub T);

The Frequency type is a generic wrapper around type T that implements the RawFrequency trait. This implementation is designed to provide a consistent interface for dealing with frequencies within the crate, enabling conversion, arithmetic operations, and other utilities that are common to frequency values.

Tuple Fields

0: T

Implementations

impl<T> Frequency<T>

where T: RawFrequency,

pub const fn new(index: T) -> Self

returns a new instance of the Frequency wrapping the given value

pub fn from_class_with_scale<N>(note: N, root: T) -> Self

where N: ToPrimitive, T: Float + FromPrimitive,

calculate the frequency (in hertz) of a given pitch class, using the formula:

F=\gamma\cdot{2^\frac{n}{12}}

pub fn from_class_on_a4<N>(note: N) -> Self

where N: ToPrimitive, T: Float + FromPrimitive,

a shorthand method for creating a new frequency from the given pitch class using A4 as the base frequency

pub fn from_pitch_class<P, K>(class: PitchClass<P, K>, root: T) -> Self

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

a method for directly converting an instance of the PitchClass into a frequency

pub fn init<F>(f: F) -> Self

where F: FnOnce() -> T,

initializes a new frequency by capturing the result of the given function

pub fn one() -> Self

where T: One,

returns a new Frequency with the value of one

pub fn zero() -> Self

where T: Zero,

returns a new Frequency with the value of zero

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

returns a pointer to the inner value

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

returns a mutable pointer to the inner value

pub fn value(self) -> T

consumes the index returning the inner value

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

returns an immutable reference to the inner value

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

returns a mutable reference to the inner value

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

where F: FnOnce(T) -> U,

apply a function to the inner value and returns a new Frequency wrapping the result

pub fn apply<U, F>(&self, f: F) -> Frequency<U>

where F: FnMut(&T) -> U,

apply a function to a reference of the current frequency, capturing the result in a new instance

pub fn apply_inplace<F>(&mut self, f: F) -> &mut Self

where F: FnOnce(&mut T),

applies the given function to m

pub const fn replace(&mut self, index: T) -> T

replaces the inner value with the given one and returns the old value

pub fn set(&mut self, index: T) -> &mut Self

set the index to the given value

pub const fn swap(&mut self, other: &mut Self)

swap the values of two indices

pub fn take(&mut self) -> T

where T: Default,

takes and returns the inner value, replacing it with the logical default of the type T

pub fn with<U>(self, other: U) -> Frequency<U>

consumes the current instance to create another with the given value

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

returns a new instance containing a reference to the inner value

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

returns a new instance containing a mutable reference to the inner value

pub fn classify_by<Z>(&self, base: T) -> Z

where Self: ClassifyBy<T, Output = Z>,

Compute the pitch class of a frequency (in hertz), using the formula:

n = 12\cdot\log_2(\frac{F}{\gamma})

impl<T> Frequency<&T>

where T: RawFrequency,

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

where T: Clone,

returns a new instance of the Frequency with a cloned instance of the current value.

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

where T: Copy,

returns a new instance of the Frequency with a copied instance of the current value.

impl<T> Frequency<&mut T>

where T: RawFrequency,

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

where T: Clone,

returns a new instance of the Frequency with a cloned instance of the current value.

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

where T: Copy,

returns a new instance of the Frequency with a copied instance of the current value.

Trait Implementations

impl<'a, _A, _B, _C> Add<&'a Frequency<_B>> for &'a Frequency<_A>

where &'a _A: Add<&'a _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the + operator.

fn add(self, rhs: &'a Frequency<_B>) -> Self::Output

Performs the + operation.

impl<'a, _A, _B, _C> Add<&'a Frequency<_B>> for Frequency<_A>

where _A: Add<&'a _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the + operator.

fn add(self, rhs: &'a Frequency<_B>) -> Self::Output

Performs the + operation.

impl<'a, _A, _B, _C> Add<&'a mut Frequency<_B>> for &'a mut Frequency<_A>

where &'a mut _A: Add<&'a mut _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the + operator.

fn add(self, rhs: &'a mut Frequency<_B>) -> Self::Output

Performs the + operation.

impl<'a, _A, _B, _C> Add<&'a mut Frequency<_B>> for Frequency<_A>

where _A: Add<&'a mut _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the + operator.

fn add(self, rhs: &'a mut Frequency<_B>) -> Self::Output

Performs the + operation.

impl<'a, _A, _B, _C> Add<Frequency<_B>> for &'a Frequency<_A>

where &'a _A: Add<_B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the + operator.

fn add(self, rhs: Frequency<_B>) -> Self::Output

Performs the + operation.

impl<'a, _A, _B, _C> Add<Frequency<_B>> for &'a mut Frequency<_A>

where &'a mut _A: Add<_B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the + operator.

fn add(self, rhs: Frequency<_B>) -> Self::Output

Performs the + operation.

impl<_A, _B, _C> Add<Frequency<_B>> for Frequency<_A>

where _A: Add<_B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the + operator.

fn add(self, rhs: Frequency<_B>) -> Self::Output

Performs the + operation.

impl<_A, _B> AddAssign<Frequency<_B>> for Frequency<_A>

where _A: AddAssign<_B>,

fn add_assign(&mut self, rhs: Frequency<_B>)

Performs the += operation.

impl<T> AsMut<T> for Frequency<T>

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

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

impl<T> AsRef<T> for Frequency<T>

fn as_ref(&self) -> &T

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

impl<T> Binary for Frequency<T>

where T: Binary,

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

Formats the value using the given formatter.

impl<'a, _A, _B, _C> BitAnd<&'a Frequency<_B>> for &'a Frequency<_A>

where &'a _A: BitAnd<&'a _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the & operator.

fn bitand(self, rhs: &'a Frequency<_B>) -> Self::Output

Performs the & operation.

impl<'a, _A, _B, _C> BitAnd<&'a Frequency<_B>> for Frequency<_A>

where _A: BitAnd<&'a _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the & operator.

fn bitand(self, rhs: &'a Frequency<_B>) -> Self::Output

Performs the & operation.

impl<'a, _A, _B, _C> BitAnd<&'a mut Frequency<_B>> for &'a mut Frequency<_A>

where &'a mut _A: BitAnd<&'a mut _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the & operator.

fn bitand(self, rhs: &'a mut Frequency<_B>) -> Self::Output

Performs the & operation.

impl<'a, _A, _B, _C> BitAnd<&'a mut Frequency<_B>> for Frequency<_A>

where _A: BitAnd<&'a mut _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the & operator.

fn bitand(self, rhs: &'a mut Frequency<_B>) -> Self::Output

Performs the & operation.

impl<'a, _A, _B, _C> BitAnd<Frequency<_B>> for &'a Frequency<_A>

where &'a _A: BitAnd<_B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the & operator.

fn bitand(self, rhs: Frequency<_B>) -> Self::Output

Performs the & operation.

impl<'a, _A, _B, _C> BitAnd<Frequency<_B>> for &'a mut Frequency<_A>

where &'a mut _A: BitAnd<_B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the & operator.

fn bitand(self, rhs: Frequency<_B>) -> Self::Output

Performs the & operation.

impl<_A, _B, _C> BitAnd<Frequency<_B>> for Frequency<_A>

where _A: BitAnd<_B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the & operator.

fn bitand(self, rhs: Frequency<_B>) -> Self::Output

Performs the & operation.

impl<_A, _B> BitAndAssign<Frequency<_B>> for Frequency<_A>

where _A: BitAndAssign<_B>,

fn bitand_assign(&mut self, rhs: Frequency<_B>)

Performs the &= operation.

impl<'a, _A, _B, _C> BitOr<&'a Frequency<_B>> for &'a Frequency<_A>

where &'a _A: BitOr<&'a _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the | operator.

fn bitor(self, rhs: &'a Frequency<_B>) -> Self::Output

Performs the | operation.

impl<'a, _A, _B, _C> BitOr<&'a Frequency<_B>> for Frequency<_A>

where _A: BitOr<&'a _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the | operator.

fn bitor(self, rhs: &'a Frequency<_B>) -> Self::Output

Performs the | operation.

impl<'a, _A, _B, _C> BitOr<&'a mut Frequency<_B>> for &'a mut Frequency<_A>

where &'a mut _A: BitOr<&'a mut _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the | operator.

fn bitor(self, rhs: &'a mut Frequency<_B>) -> Self::Output

Performs the | operation.

impl<'a, _A, _B, _C> BitOr<&'a mut Frequency<_B>> for Frequency<_A>

where _A: BitOr<&'a mut _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the | operator.

fn bitor(self, rhs: &'a mut Frequency<_B>) -> Self::Output

Performs the | operation.

impl<'a, _A, _B, _C> BitOr<Frequency<_B>> for &'a Frequency<_A>

where &'a _A: BitOr<_B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the | operator.

fn bitor(self, rhs: Frequency<_B>) -> Self::Output

Performs the | operation.

impl<'a, _A, _B, _C> BitOr<Frequency<_B>> for &'a mut Frequency<_A>

where &'a mut _A: BitOr<_B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the | operator.

fn bitor(self, rhs: Frequency<_B>) -> Self::Output

Performs the | operation.

impl<_A, _B, _C> BitOr<Frequency<_B>> for Frequency<_A>

where _A: BitOr<_B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the | operator.

fn bitor(self, rhs: Frequency<_B>) -> Self::Output

Performs the | operation.

impl<_A, _B> BitOrAssign<Frequency<_B>> for Frequency<_A>

where _A: BitOrAssign<_B>,

fn bitor_assign(&mut self, rhs: Frequency<_B>)

Performs the |= operation.

impl<'a, _A, _B, _C> BitXor<&'a Frequency<_B>> for &'a Frequency<_A>

where &'a _A: BitXor<&'a _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &'a Frequency<_B>) -> Self::Output

Performs the ^ operation.

impl<'a, _A, _B, _C> BitXor<&'a Frequency<_B>> for Frequency<_A>

where _A: BitXor<&'a _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &'a Frequency<_B>) -> Self::Output

Performs the ^ operation.

impl<'a, _A, _B, _C> BitXor<&'a mut Frequency<_B>> for &'a mut Frequency<_A>

where &'a mut _A: BitXor<&'a mut _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &'a mut Frequency<_B>) -> Self::Output

Performs the ^ operation.

impl<'a, _A, _B, _C> BitXor<&'a mut Frequency<_B>> for Frequency<_A>

where _A: BitXor<&'a mut _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &'a mut Frequency<_B>) -> Self::Output

Performs the ^ operation.

impl<'a, _A, _B, _C> BitXor<Frequency<_B>> for &'a Frequency<_A>

where &'a _A: BitXor<_B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Frequency<_B>) -> Self::Output

Performs the ^ operation.

impl<'a, _A, _B, _C> BitXor<Frequency<_B>> for &'a mut Frequency<_A>

where &'a mut _A: BitXor<_B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Frequency<_B>) -> Self::Output

Performs the ^ operation.

impl<_A, _B, _C> BitXor<Frequency<_B>> for Frequency<_A>

where _A: BitXor<_B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Frequency<_B>) -> Self::Output

Performs the ^ operation.

impl<_A, _B> BitXorAssign<Frequency<_B>> for Frequency<_A>

where _A: BitXorAssign<_B>,

fn bitxor_assign(&mut self, rhs: Frequency<_B>)

Performs the ^= operation.

impl<T> Borrow<T> for Frequency<T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T> BorrowMut<T> for Frequency<T>

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

Mutably borrows from an owned value.

impl<T> ClassifyBy<T> for Frequency<T>

where T: RawFrequency + Float + FromPrimitive,

type Output = isize

fn classify_by(&self, base: T) -> Self::Output

impl<T: Clone> Clone for Frequency<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Frequency<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T: Default> Default for Frequency<T>

fn default() -> Frequency<T>

Returns the “default value” for a type.

impl<T> Deref for Frequency<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> DerefMut for Frequency<T>

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

Mutably dereferences the value.

impl<T> Display for Frequency<T>

where T: Display,

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

Formats the value using the given formatter.

impl<'a, _A, _B, _C> Div<&'a Frequency<_B>> for &'a Frequency<_A>

where &'a _A: Div<&'a _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the / operator.

fn div(self, rhs: &'a Frequency<_B>) -> Self::Output

Performs the / operation.

impl<'a, _A, _B, _C> Div<&'a Frequency<_B>> for Frequency<_A>

where _A: Div<&'a _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the / operator.

fn div(self, rhs: &'a Frequency<_B>) -> Self::Output

Performs the / operation.

impl<'a, _A, _B, _C> Div<&'a mut Frequency<_B>> for &'a mut Frequency<_A>

where &'a mut _A: Div<&'a mut _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the / operator.

fn div(self, rhs: &'a mut Frequency<_B>) -> Self::Output

Performs the / operation.

impl<'a, _A, _B, _C> Div<&'a mut Frequency<_B>> for Frequency<_A>

where _A: Div<&'a mut _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the / operator.

fn div(self, rhs: &'a mut Frequency<_B>) -> Self::Output

Performs the / operation.

impl<'a, _A, _B, _C> Div<Frequency<_B>> for &'a Frequency<_A>

where &'a _A: Div<_B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the / operator.

fn div(self, rhs: Frequency<_B>) -> Self::Output

Performs the / operation.

impl<'a, _A, _B, _C> Div<Frequency<_B>> for &'a mut Frequency<_A>

where &'a mut _A: Div<_B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the / operator.

fn div(self, rhs: Frequency<_B>) -> Self::Output

Performs the / operation.

impl<_A, _B, _C> Div<Frequency<_B>> for Frequency<_A>

where _A: Div<_B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the / operator.

fn div(self, rhs: Frequency<_B>) -> Self::Output

Performs the / operation.

impl<_A, _B> DivAssign<Frequency<_B>> for Frequency<_A>

where _A: DivAssign<_B>,

fn div_assign(&mut self, rhs: Frequency<_B>)

Performs the /= operation.

impl<T> From<T> for Frequency<T>

where T: RawFrequency,

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for Frequency<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> LowerExp for Frequency<T>

where T: LowerExp,

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

Formats the value using the given formatter.

impl<T> LowerHex for Frequency<T>

where T: LowerHex,

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

Formats the value using the given formatter.

impl<'a, _A, _B, _C> Mul<&'a Frequency<_B>> for &'a Frequency<_A>

where &'a _A: Mul<&'a _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the * operator.

fn mul(self, rhs: &'a Frequency<_B>) -> Self::Output

Performs the * operation.

impl<'a, _A, _B, _C> Mul<&'a Frequency<_B>> for Frequency<_A>

where _A: Mul<&'a _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the * operator.

fn mul(self, rhs: &'a Frequency<_B>) -> Self::Output

Performs the * operation.

impl<'a, _A, _B, _C> Mul<&'a mut Frequency<_B>> for &'a mut Frequency<_A>

where &'a mut _A: Mul<&'a mut _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the * operator.

fn mul(self, rhs: &'a mut Frequency<_B>) -> Self::Output

Performs the * operation.

impl<'a, _A, _B, _C> Mul<&'a mut Frequency<_B>> for Frequency<_A>

where _A: Mul<&'a mut _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the * operator.

fn mul(self, rhs: &'a mut Frequency<_B>) -> Self::Output

Performs the * operation.

impl<'a, _A, _B, _C> Mul<Frequency<_B>> for &'a Frequency<_A>

where &'a _A: Mul<_B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the * operator.

fn mul(self, rhs: Frequency<_B>) -> Self::Output

Performs the * operation.

impl<'a, _A, _B, _C> Mul<Frequency<_B>> for &'a mut Frequency<_A>

where &'a mut _A: Mul<_B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the * operator.

fn mul(self, rhs: Frequency<_B>) -> Self::Output

Performs the * operation.

impl<_A, _B, _C> Mul<Frequency<_B>> for Frequency<_A>

where _A: Mul<_B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the * operator.

fn mul(self, rhs: Frequency<_B>) -> Self::Output

Performs the * operation.

impl<_A, _B> MulAssign<Frequency<_B>> for Frequency<_A>

where _A: MulAssign<_B>,

fn mul_assign(&mut self, rhs: Frequency<_B>)

Performs the *= operation.

impl<'a, _A, _B> Neg for &'a Frequency<_A>

where &'a _A: Neg<Output = _B>,

type Output = Frequency<_B>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<'a, _A, _B> Neg for &'a mut Frequency<_A>

where &'a mut _A: Neg<Output = _B>,

type Output = Frequency<_B>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<_A, _B> Neg for Frequency<_A>

where _A: Neg<Output = _B>,

type Output = Frequency<_B>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<'a, _A, _B> Not for &'a Frequency<_A>

where &'a _A: Not<Output = _B>,

type Output = Frequency<_B>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<'a, _A, _B> Not for &'a mut Frequency<_A>

where &'a mut _A: Not<Output = _B>,

type Output = Frequency<_B>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<_A, _B> Not for Frequency<_A>

where _A: Not<Output = _B>,

type Output = Frequency<_B>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<T> Num for Frequency<T>

where T: Num,

type FromStrRadixErr = <T as Num>::FromStrRadixErr

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

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

impl<T> Octal for Frequency<T>

where T: Octal,

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

Formats the value using the given formatter.

impl<T> One for Frequency<T>

where T: One,

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

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

where T: PartialEq,

fn eq(&self, other: &&'a 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<'a, T> PartialEq<&'a mut T> for Frequency<T>

where T: PartialEq,

fn eq(&self, other: &&'a mut 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<T> for Frequency<T>

where T: PartialEq,

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

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<'a, T> PartialOrd<&'a T> for Frequency<T>

where T: PartialOrd,

fn partial_cmp(&self, other: &&'a 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<'a, T> PartialOrd<&'a mut T> for Frequency<T>

where T: PartialOrd,

fn partial_cmp(&self, other: &&'a mut 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<T> for Frequency<T>

where T: PartialOrd,

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

fn partial_cmp(&self, other: &Frequency<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> Pointer for Frequency<T>

where T: Pointer,

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

Formats the value using the given formatter.

impl<'a, _A, _B, _C> Rem<&'a Frequency<_B>> for &'a Frequency<_A>

where &'a _A: Rem<&'a _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the % operator.

fn rem(self, rhs: &'a Frequency<_B>) -> Self::Output

Performs the % operation.

impl<'a, _A, _B, _C> Rem<&'a Frequency<_B>> for Frequency<_A>

where _A: Rem<&'a _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the % operator.

fn rem(self, rhs: &'a Frequency<_B>) -> Self::Output

Performs the % operation.

impl<'a, _A, _B, _C> Rem<&'a mut Frequency<_B>> for &'a mut Frequency<_A>

where &'a mut _A: Rem<&'a mut _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the % operator.

fn rem(self, rhs: &'a mut Frequency<_B>) -> Self::Output

Performs the % operation.

impl<'a, _A, _B, _C> Rem<&'a mut Frequency<_B>> for Frequency<_A>

where _A: Rem<&'a mut _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the % operator.

fn rem(self, rhs: &'a mut Frequency<_B>) -> Self::Output

Performs the % operation.

impl<'a, _A, _B, _C> Rem<Frequency<_B>> for &'a Frequency<_A>

where &'a _A: Rem<_B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the % operator.

fn rem(self, rhs: Frequency<_B>) -> Self::Output

Performs the % operation.

impl<'a, _A, _B, _C> Rem<Frequency<_B>> for &'a mut Frequency<_A>

where &'a mut _A: Rem<_B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the % operator.

fn rem(self, rhs: Frequency<_B>) -> Self::Output

Performs the % operation.

impl<_A, _B, _C> Rem<Frequency<_B>> for Frequency<_A>

where _A: Rem<_B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the % operator.

fn rem(self, rhs: Frequency<_B>) -> Self::Output

Performs the % operation.

impl<_A, _B> RemAssign<Frequency<_B>> for Frequency<_A>

where _A: RemAssign<_B>,

fn rem_assign(&mut self, rhs: Frequency<_B>)

Performs the %= operation.

impl<'a, _A, _B, _C> Shl<&'a Frequency<_B>> for &'a Frequency<_A>

where &'a _A: Shl<&'a _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the << operator.

fn shl(self, rhs: &'a Frequency<_B>) -> Self::Output

Performs the << operation.

impl<'a, _A, _B, _C> Shl<&'a Frequency<_B>> for Frequency<_A>

where _A: Shl<&'a _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the << operator.

fn shl(self, rhs: &'a Frequency<_B>) -> Self::Output

Performs the << operation.

impl<'a, _A, _B, _C> Shl<&'a mut Frequency<_B>> for &'a mut Frequency<_A>

where &'a mut _A: Shl<&'a mut _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the << operator.

fn shl(self, rhs: &'a mut Frequency<_B>) -> Self::Output

Performs the << operation.

impl<'a, _A, _B, _C> Shl<&'a mut Frequency<_B>> for Frequency<_A>

where _A: Shl<&'a mut _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the << operator.

fn shl(self, rhs: &'a mut Frequency<_B>) -> Self::Output

Performs the << operation.

impl<'a, _A, _B, _C> Shl<Frequency<_B>> for &'a Frequency<_A>

where &'a _A: Shl<_B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the << operator.

fn shl(self, rhs: Frequency<_B>) -> Self::Output

Performs the << operation.

impl<'a, _A, _B, _C> Shl<Frequency<_B>> for &'a mut Frequency<_A>

where &'a mut _A: Shl<_B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the << operator.

fn shl(self, rhs: Frequency<_B>) -> Self::Output

Performs the << operation.

impl<_A, _B, _C> Shl<Frequency<_B>> for Frequency<_A>

where _A: Shl<_B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the << operator.

fn shl(self, rhs: Frequency<_B>) -> Self::Output

Performs the << operation.

impl<_A, _B> ShlAssign<Frequency<_B>> for Frequency<_A>

where _A: ShlAssign<_B>,

fn shl_assign(&mut self, rhs: Frequency<_B>)

Performs the <<= operation.

impl<'a, _A, _B, _C> Shr<&'a Frequency<_B>> for &'a Frequency<_A>

where &'a _A: Shr<&'a _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the >> operator.

fn shr(self, rhs: &'a Frequency<_B>) -> Self::Output

Performs the >> operation.

impl<'a, _A, _B, _C> Shr<&'a Frequency<_B>> for Frequency<_A>

where _A: Shr<&'a _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the >> operator.

fn shr(self, rhs: &'a Frequency<_B>) -> Self::Output

Performs the >> operation.

impl<'a, _A, _B, _C> Shr<&'a mut Frequency<_B>> for &'a mut Frequency<_A>

where &'a mut _A: Shr<&'a mut _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the >> operator.

fn shr(self, rhs: &'a mut Frequency<_B>) -> Self::Output

Performs the >> operation.

impl<'a, _A, _B, _C> Shr<&'a mut Frequency<_B>> for Frequency<_A>

where _A: Shr<&'a mut _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the >> operator.

fn shr(self, rhs: &'a mut Frequency<_B>) -> Self::Output

Performs the >> operation.

impl<'a, _A, _B, _C> Shr<Frequency<_B>> for &'a Frequency<_A>

where &'a _A: Shr<_B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the >> operator.

fn shr(self, rhs: Frequency<_B>) -> Self::Output

Performs the >> operation.

impl<'a, _A, _B, _C> Shr<Frequency<_B>> for &'a mut Frequency<_A>

where &'a mut _A: Shr<_B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the >> operator.

fn shr(self, rhs: Frequency<_B>) -> Self::Output

Performs the >> operation.

impl<_A, _B, _C> Shr<Frequency<_B>> for Frequency<_A>

where _A: Shr<_B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the >> operator.

fn shr(self, rhs: Frequency<_B>) -> Self::Output

Performs the >> operation.

impl<_A, _B> ShrAssign<Frequency<_B>> for Frequency<_A>

where _A: ShrAssign<_B>,

fn shr_assign(&mut self, rhs: Frequency<_B>)

Performs the >>= operation.

impl<'a, _A, _B, _C> Sub<&'a Frequency<_B>> for &'a Frequency<_A>

where &'a _A: Sub<&'a _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the - operator.

fn sub(self, rhs: &'a Frequency<_B>) -> Self::Output

Performs the - operation.

impl<'a, _A, _B, _C> Sub<&'a Frequency<_B>> for Frequency<_A>

where _A: Sub<&'a _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the - operator.

fn sub(self, rhs: &'a Frequency<_B>) -> Self::Output

Performs the - operation.

impl<'a, _A, _B, _C> Sub<&'a mut Frequency<_B>> for &'a mut Frequency<_A>

where &'a mut _A: Sub<&'a mut _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the - operator.

fn sub(self, rhs: &'a mut Frequency<_B>) -> Self::Output

Performs the - operation.

impl<'a, _A, _B, _C> Sub<&'a mut Frequency<_B>> for Frequency<_A>

where _A: Sub<&'a mut _B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the - operator.

fn sub(self, rhs: &'a mut Frequency<_B>) -> Self::Output

Performs the - operation.

impl<'a, _A, _B, _C> Sub<Frequency<_B>> for &'a Frequency<_A>

where &'a _A: Sub<_B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the - operator.

fn sub(self, rhs: Frequency<_B>) -> Self::Output

Performs the - operation.

impl<'a, _A, _B, _C> Sub<Frequency<_B>> for &'a mut Frequency<_A>

where &'a mut _A: Sub<_B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the - operator.

fn sub(self, rhs: Frequency<_B>) -> Self::Output

Performs the - operation.

impl<_A, _B, _C> Sub<Frequency<_B>> for Frequency<_A>

where _A: Sub<_B, Output = _C>,

type Output = Frequency<_C>

The resulting type after applying the - operator.

fn sub(self, rhs: Frequency<_B>) -> Self::Output

Performs the - operation.

impl<_A, _B> SubAssign<Frequency<_B>> for Frequency<_A>

where _A: SubAssign<_B>,

fn sub_assign(&mut self, rhs: Frequency<_B>)

Performs the -= operation.

impl<T> UpperExp for Frequency<T>

where T: UpperExp,

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

Formats the value using the given formatter.

impl<T> UpperHex for Frequency<T>

where T: UpperHex,

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

Formats the value using the given formatter.

impl<T> Zero for Frequency<T>

where T: Zero,

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<T: Copy> Copy for Frequency<T>

impl<T: Eq> Eq for Frequency<T>

impl<T> StructuralPartialEq for Frequency<T>