Struct FiniteF32 

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

Wrapper around f32 that guarantees a finite number, i.e., neither NaN nor infinite. This makes the number orderable and sortable.

The type compares and calculates with f32 directly, so there is rarely a need to unwrap it:

use spectrum_analyzer::FiniteF32;

let value = FiniteF32::from(0.5);
assert!(value > 0.25);
assert_eq!(value, 0.5);
assert_eq!(value * 2.0, 1.0);

Panics

Creating a value from an f32 that is not finite panics, and so does an operation between two values of this type whose result is not finite. Self::try_new checks instead.

Implementations

impl FiniteF32

pub const fn try_new(val: f32) -> Option<Self>

Creates a new value, or None if val is not finite.

pub const fn val(self) -> f32

Returns the underlying f32.

Trait Implementations

impl Add for FiniteF32

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

Panics

If the result is not finite.

type Output = FiniteF32

The resulting type after applying the + operator.

impl Add<FiniteF32> for f32

type Output = f32

The resulting type after applying the + operator.

fn add(self, rhs: FiniteF32) -> Self::Output

Performs the + operation.

impl Add<f32> for FiniteF32

type Output = f32

The resulting type after applying the + operator.

fn add(self, rhs: f32) -> Self::Output

Performs the + operation.

impl Clone for FiniteF32

fn clone(&self) -> FiniteF32

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FiniteF32

impl Debug for FiniteF32

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

Formats the value using the given formatter.

impl Default for FiniteF32

fn default() -> FiniteF32

Returns the “default value” for a type.

impl Display for FiniteF32

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

Formats the value using the given formatter.

impl Div for FiniteF32

fn div(self, rhs: Self) -> Self::Output

Panics

If the result is not finite.

type Output = FiniteF32

The resulting type after applying the / operator.

impl Div<FiniteF32> for f32

type Output = f32

The resulting type after applying the / operator.

fn div(self, rhs: FiniteF32) -> Self::Output

Performs the / operation.

impl Div<f32> for FiniteF32

type Output = f32

The resulting type after applying the / operator.

fn div(self, rhs: f32) -> Self::Output

Performs the / operation.

impl Eq for FiniteF32

impl From<FiniteF32> for f32

fn from(val: FiniteF32) -> Self

Converts to this type from the input type.

impl From<FiniteF32> for NonNegF32

fn from(val: FiniteF32) -> Self

Panics

If val is negative.

impl From<NonNegF32> for FiniteF32

fn from(val: NonNegF32) -> Self

Converts to this type from the input type.

impl From<f32> for FiniteF32

fn from(val: f32) -> Self

Panics

If val is NaN or infinite.

impl Mul for FiniteF32

fn mul(self, rhs: Self) -> Self::Output

Panics

If the result is not finite.

type Output = FiniteF32

The resulting type after applying the * operator.

impl Mul<FiniteF32> for f32

type Output = f32

The resulting type after applying the * operator.

fn mul(self, rhs: FiniteF32) -> Self::Output

Performs the * operation.

impl Mul<f32> for FiniteF32

type Output = f32

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> Self::Output

Performs the * operation.

impl Neg for FiniteF32

fn neg(self) -> Self::Output

Negating a finite number always yields a finite number.

type Output = FiniteF32

The resulting type after applying the - operator.

impl Ord for FiniteF32

fn cmp(&self, other: &Self) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for FiniteF32

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<FiniteF32> for f32

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<f32> for FiniteF32

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for FiniteF32

fn partial_cmp(&self, other: &Self) -> 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 PartialOrd<FiniteF32> for f32

fn partial_cmp(&self, other: &FiniteF32) -> 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 PartialOrd<f32> for FiniteF32

fn partial_cmp(&self, other: &f32) -> 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 Sub for FiniteF32

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

Panics

If the result is not finite.

type Output = FiniteF32

The resulting type after applying the - operator.

impl Sub<FiniteF32> for f32

type Output = f32

The resulting type after applying the - operator.

fn sub(self, rhs: FiniteF32) -> Self::Output

Performs the - operation.

impl Sub<f32> for FiniteF32

type Output = f32

The resulting type after applying the - operator.

fn sub(self, rhs: f32) -> Self::Output

Performs the - operation.