Struct NonNegative

pub struct NonNegative<T: Float>(/* private fields */);

Wrapper type guaranteeing a non-negative floating-point value.

Implementations

impl<T: Float> NonNegative<T>

pub fn zero() -> Self

where T: Zero,

Returns a NonNegative wrapping zero.

pub fn try_new(value: T) -> Result<Self, NonNegativeError>

Attempts to create a new NonNegative<T> from a value.

Returns Err if the value is negative or not finite.

pub fn new(value: T) -> Self

Creates a new NonNegative<T> or panics if invalid.

Panics

Panics if the value is negative or not finite.

pub fn get(&self) -> T

Returns the inner float value.

Trait Implementations

impl<T: Clone + Float> Clone for NonNegative<T>

fn clone(&self) -> NonNegative<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Float> Debug for NonNegative<T>

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

Formats the value using the given formatter.

impl<T: Float + Zero> Default for NonNegative<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Float + Display> Display for NonNegative<T>

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

Formats the value using the given formatter.

impl<T: PartialEq + Float> PartialEq for NonNegative<T>

fn eq(&self, other: &NonNegative<T>) -> 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<T: PartialOrd + Float> PartialOrd for NonNegative<T>

fn partial_cmp(&self, other: &NonNegative<T>) -> 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<T: Copy + Float> Copy for NonNegative<T>

impl<T: Float> StructuralPartialEq for NonNegative<T>