Struct Scale 

pub struct Scale<T = f32> {
    pub root: Frequency<T>,
}

The Scale implementation uses the defined root or anchor frequency as the basis for classfifications and other related computations.

Fields

root: Frequency<T>

Implementations

impl<T> Scale<T>

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

pub const fn from_freq(root: Frequency<T>) -> Self

creates a new Scale from the given root frequency

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

returns a reference to the base frequency

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

returns a mutable reference to the base frequency

pub fn classify(&self, Frequency: Frequency<T>) -> Option<isize>

where T: RawFrequency + Float + FromPrimitive,

classifies the given frequency as a pitch class n, using the formula:

n=\text{round}\Bigg(12\cdot\log_{2}\bigg(\frac{F}{\beta}\bigg)\Bigg)

pub fn get_freq_of_class(&self, n: isize) -> Frequency<T>

where T: RawFrequency + Float + FromPrimitive,

returns the frequency [Hz] of the given pitch class n, using the formula:

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

Trait Implementations

impl<T: Clone> Clone for Scale<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Scale<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Scale<T>

fn default() -> Scale<T>

Returns the “default value” for a type.

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

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

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

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

impl<T: Eq> Eq for Scale<T>

impl<T> StructuralPartialEq for Scale<T>