Struct NonNegF32 

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

Wrapper around FiniteF32 that additionally guarantees a number that is not negative, so 0.0 or higher.

Like FiniteF32, it compares and calculates with f32 directly. Operations that can leave the range, such as a subtraction or a negation, return a FiniteF32.

use spectrum_analyzer::NonNegF32;

let value = NonNegF32::from(0.5);
assert_eq!(value, 0.5);
assert!(value > 0.25);
assert_eq!(NonNegF32::from(0.25) - value, -0.25);

Panics

Creating a value from a number that is negative or not finite panics, and so does an operation whose result leaves the range. Self::try_new checks instead.

Implementations

impl NonNegF32

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

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

pub const fn val(self) -> f32

Returns the underlying f32.

Trait Implementations

impl Add for NonNegF32

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

Panics

If the result is not finite.

type Output = NonNegF32

The resulting type after applying the + operator.

impl Add<NonNegF32> for f32

type Output = f32

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<f32> for NonNegF32

type Output = f32

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for NonNegF32

fn clone(&self) -> NonNegF32

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for NonNegF32

impl Debug for NonNegF32

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

Formats the value using the given formatter.

impl Default for NonNegF32

fn default() -> NonNegF32

Returns the “default value” for a type.

impl Display for NonNegF32

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

Formats the value using the given formatter.

impl Div for NonNegF32

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

Panics

If the result is not finite.

type Output = NonNegF32

The resulting type after applying the / operator.

impl Div<NonNegF32> for f32

type Output = f32

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<f32> for NonNegF32

type Output = f32

The resulting type after applying the / operator.

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

Performs the / operation.

impl Eq for NonNegF32

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<NonNegF32> for f32

fn from(val: NonNegF32) -> Self

Converts to this type from the input type.

impl From<f32> for NonNegF32

fn from(val: f32) -> Self

Panics

If val is negative, NaN or infinite.

impl Mul for NonNegF32

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

Panics

If the result is not finite.

type Output = NonNegF32

The resulting type after applying the * operator.

impl Mul<NonNegF32> for f32

type Output = f32

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32> for NonNegF32

type Output = f32

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for NonNegF32

fn neg(self) -> Self::Output

Negating leaves the range, so the result is a FiniteF32.

type Output = FiniteF32

The resulting type after applying the - operator.

impl Ord for NonNegF32

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 NonNegF32

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<NonNegF32> for f32

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<f32> for NonNegF32

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for NonNegF32

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<NonNegF32> for f32

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

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 NonNegF32

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

A subtraction can leave the range, so the result is a FiniteF32. The difference of two finite numbers of the same sign is finite, so this cannot panic.

type Output = FiniteF32

The resulting type after applying the - operator.

impl Sub<NonNegF32> for f32

type Output = f32

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<f32> for NonNegF32

type Output = f32

The resulting type after applying the - operator.

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

Performs the - operation.