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) -> Scale<T>

pub fn a4() -> Scale<T>

where T: FromPrimitive,

initialize a new scale using A4 as the root

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

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<T>) -> Option<isize>

where T: RawFrequency + Float + FromPrimitive,

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

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

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

where T: RawFrequency + Float + FromPrimitive,

returns the frequency $F$, in hertz [Hz], of the given pitch class n, using:

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

impl Scale

pub const A4: Frequency<f32>

impl Scale<f64>

pub const A4: Frequency

impl Scale<u16>

pub const A4: Frequency<u16>

impl Scale<u32>

pub const A4: Frequency<u32>

impl Scale<u64>

pub const A4: Frequency<u64>

impl Scale<u128>

pub const A4: Frequency<u128>

impl Scale<usize>

pub const A4: Frequency<usize>

impl Scale<i16>

pub const A4: Frequency<i16>

impl Scale<i32>

pub const A4: Frequency<i32>

impl Scale<i64>

pub const A4: Frequency<i64>

impl Scale<i128>

pub const A4: Frequency<i128>

impl Scale<isize>

pub const A4: Frequency<isize>

Trait Implementations

impl<T> Clone for Scale<T>

where T: Clone,

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 for Scale<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for Scale<T>

where T: Default,

fn default() -> Scale<T>

Returns the “default value” for a type.

impl<T> Hash for Scale<T>

where T: Hash,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 for Scale<T>

where T: Ord,

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 for Scale<T>

where T: PartialEq,

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 for Scale<T>

where T: PartialOrd,

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 for Scale<T>

where T: Copy,

impl<T> Eq for Scale<T>

where T: Eq,

impl<T> StructuralPartialEq for Scale<T>