Struct Amplitude 

pub struct Amplitude(pub f64);

A non-negative linear amplitude.

Examples

use sim_lib_sound_core::Amplitude;

let unity = Amplitude::from_db(0.0);
assert!((unity.0 - 1.0).abs() < 1e-9);
assert!(Amplitude::new(-1.0).is_err());

Tuple Fields

0: f64

Implementations

impl Amplitude

pub fn new(linear: f64) -> Result<Self, SoundCoreError>

Builds an amplitude, returning SoundCoreError::InvalidAmplitude when linear is negative or non-finite.

pub fn from_db(db: f64) -> Self

Builds an amplitude from a decibel value relative to unity gain.

pub fn to_db(self) -> f64

Returns this amplitude expressed in decibels relative to unity gain.

Trait Implementations

impl Clone for Amplitude

fn clone(&self) -> Amplitude

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Amplitude

impl Debug for Amplitude

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

Formats the value using the given formatter.

impl PartialEq for Amplitude

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for Amplitude

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