Struct FrequencyHz 

pub struct FrequencyHz(/* private fields */);

A validated acoustic frequency in hertz.

Implementations

impl FrequencyHz

pub fn new(value: f64) -> Option<Self>

Creates a validated frequency in hertz.

pub fn value(self) -> f64

Returns the stored frequency value.

pub fn period_seconds(self) -> f64

Returns the period in seconds for this frequency.

pub fn angular_frequency_rad_per_s(self) -> f64

Returns the angular frequency in radians per second.

Trait Implementations

impl Clone for FrequencyHz

fn clone(&self) -> FrequencyHz

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrequencyHz

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

Formats the value using the given formatter.

impl PartialEq for FrequencyHz

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

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

impl StructuralPartialEq for FrequencyHz