Struct mag::Frequency

pub struct Frequency<U> where
    U: Unit,  {
    pub quantity: f64,
    // some fields omitted
}

A measurement of temporal frequency for repeating events.

Frequency is a derived quantity with a specific unit.

Operations

• Frequency + Frequency => Frequency
• Frequency - Frequency => Frequency
• Frequency * f64 => Frequency
• f64 * Frequency => Frequency
• f64 / Period => Frequency
• f64 / unit => Frequency
• f64 / Frequency => Period

Units must be the same for operations with two Frequency operands. The to method can be used for conversion.

Fields

quantity: f64

Frequency quantity

Methods

impl<U> Frequency<U> where
    U: Unit, 

pub fn new(quantity: f64) -> Self

Create a new frequency measurement

pub fn to<T: Unit>(self) -> Frequency<T>

Convert to specified units

Trait Implementations

impl<U: Clone> Clone for Frequency<U> where
    U: Unit, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<U: Copy> Copy for Frequency<U> where
    U: Unit, 

impl<U: PartialEq> PartialEq<Frequency<U>> for Frequency<U> where
    U: Unit, 

fn eq(&self, other: &Frequency<U>) -> bool

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

fn ne(&self, other: &Frequency<U>) -> bool

This method tests for !=.

impl<U> Display for Frequency<U> where
    U: Unit, 

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

Formats the value using the given formatter.

impl<U: Debug> Debug for Frequency<U> where
    U: Unit, 

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

Formats the value using the given formatter.

impl<U> Div<f64> for Frequency<U> where
    U: Unit, 

type Output = Self

The resulting type after applying the / operator.

fn div(self, other: f64) -> Self::Output

Performs the / operation.

impl<U> Div<Frequency<U>> for f64 where
    U: Unit, 

type Output = Period<U>

The resulting type after applying the / operator.

fn div(self, other: Frequency<U>) -> Self::Output

Performs the / operation.

impl<U> Sub<Frequency<U>> for Frequency<U> where
    U: Unit, 

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self::Output

Performs the - operation.

impl<U> Add<Frequency<U>> for Frequency<U> where
    U: Unit, 

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self::Output

Performs the + operation.

impl<U> Mul<f64> for Frequency<U> where
    U: Unit, 

type Output = Self

The resulting type after applying the * operator.

fn mul(self, other: f64) -> Self::Output

Performs the * operation.

impl<U> Mul<Frequency<U>> for f64 where
    U: Unit, 

type Output = Frequency<U>

The resulting type after applying the * operator.

fn mul(self, other: Frequency<U>) -> Self::Output

Performs the * operation.

impl<U> StructuralPartialEq for Frequency<U> where
    U: Unit,