Struct pitch_calc::scaled_perc::ScaledPerc

pub struct ScaledPerc(pub Perc, pub ScaleWeight);

Pitch representation in the form of a scaled percentage between the min and max hz.

Methods

impl ScaledPerc

pub fn new(perc: Perc) -> ScaledPerc

A constructor for a ScaledPerc that uses the default weight.

pub fn scaled_perc(&self) -> Perc

Return the value as a scaled percentage.

pub fn scale_weight(&self) -> ScaleWeight

Return the scale weight.

pub fn hz(&self) -> Hz

Convert to the unit value of the equivalent frequency in Hz.

pub fn to_hz(&self) -> Hz

Convert to the equivalent frequency in Hz.

pub fn letter_octave(&self) -> (Letter, Octave)

Convert to (Letter, Octave) tuple.

pub fn letter(&self) -> Letter

Convert to Letter.

pub fn octave(&self) -> Octave

Convert to Octave.

pub fn to_letter_octave(&self) -> LetterOctave

Convert to LetterOctave.

pub fn mel(&self) -> Mel

Convert to the unit value of a Mel.

pub fn to_mel(&self) -> Mel

Convert to a Mel struct.

pub fn perc(&self) -> Perc

Convert to the unit value of a Perc struct.

pub fn to_perc(&self) -> Perc

Convert to Perc.

pub fn step(&self) -> Step

Convert to the unit value of a Step.

pub fn to_step(&self) -> Step

Convert to a floating point MIDI-esque Step.

Trait Implementations

impl Add<ScaledPerc> for ScaledPerc

type Output = ScaledPerc

The resulting type after applying the + operator.

fn add(self, rhs: ScaledPerc) -> ScaledPerc

Performs the + operation.

impl Clone for ScaledPerc

fn clone(&self) -> ScaledPerc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ScaledPerc

impl Debug for ScaledPerc

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

Formats the value using the given formatter.

impl Div<ScaledPerc> for ScaledPerc

type Output = ScaledPerc

The resulting type after applying the / operator.

fn div(self, rhs: ScaledPerc) -> ScaledPerc

Performs the / operation.

impl Eq for ScaledPerc

impl From<Hz> for ScaledPerc

fn from(other: Hz) -> Self

Performs the conversion.

impl From<LetterOctave> for ScaledPerc

fn from(other: LetterOctave) -> Self

Performs the conversion.

impl From<Mel> for ScaledPerc

fn from(other: Mel) -> Self

Performs the conversion.

impl From<Perc> for ScaledPerc

fn from(other: Perc) -> Self

Performs the conversion.

impl From<ScaledPerc> for Hz

fn from(other: ScaledPerc) -> Self

Performs the conversion.

impl From<ScaledPerc> for Mel

fn from(other: ScaledPerc) -> Self

Performs the conversion.

impl From<ScaledPerc> for LetterOctave

fn from(other: ScaledPerc) -> Self

Performs the conversion.

impl From<ScaledPerc> for Perc

fn from(other: ScaledPerc) -> Self

Performs the conversion.

impl From<ScaledPerc> for Step

fn from(other: ScaledPerc) -> Self

Performs the conversion.

impl From<Step> for ScaledPerc

fn from(other: Step) -> Self

Performs the conversion.

impl Mul<ScaledPerc> for ScaledPerc

type Output = ScaledPerc

The resulting type after applying the * operator.

fn mul(self, rhs: ScaledPerc) -> ScaledPerc

Performs the * operation.

impl Neg for ScaledPerc

type Output = ScaledPerc

The resulting type after applying the - operator.

fn neg(self) -> ScaledPerc

Performs the unary - operation.

impl Ord for ScaledPerc

fn cmp(&self, other: &ScaledPerc) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<ScaledPerc> for ScaledPerc

fn eq(&self, other: &ScaledPerc) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<ScaledPerc> for ScaledPerc

fn partial_cmp(&self, other: &ScaledPerc) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Rem<ScaledPerc> for ScaledPerc

type Output = ScaledPerc

The resulting type after applying the % operator.

fn rem(self, rhs: ScaledPerc) -> ScaledPerc

Performs the % operation.

impl Sub<ScaledPerc> for ScaledPerc

type Output = ScaledPerc

The resulting type after applying the - operator.

fn sub(self, rhs: ScaledPerc) -> ScaledPerc

Performs the - operation.