Struct NonNegative 

pub struct NonNegative<S>(/* private fields */);

Non-negative scalars (may be zero)

Implementations

impl<S> NonNegative<S>

where S: PartialOrd + Zero,

pub fn new(value: S) -> Option<Self>

Returns ‘None’ when called with a negative value.

Example

assert!(NonNegative::new (1.0).is_some());
assert!(NonNegative::new (0.0).is_some());
assert!(NonNegative::new (-1.0).is_none());

pub fn noisy(value: S) -> Self

Panics if negative.

Panics

let x = NonNegative::noisy (-1.0);  // panic!

pub fn unchecked(value: S) -> Self

Create a new non-negative number without checking the value.

This method is completely unchecked for release builds. Debug builds will panic if the value is negative:

let negative = NonNegative::unchecked (-1.0);   // panic!

pub fn map_noisy<F>(self, fun: F) -> Self

where F: FnMut(S) -> S,

Map an operation on the underlying scalar, panicking if the result is negative.

Example

assert_eq!(*NonNegative::abs (1.0).map_noisy (|x| 2.0 * x), 2.0);

Panics

Panics of the result is negative:

let v = NonNegative::abs (1.0).map_noisy (|x| -1.0 * x);  // panic!

impl<S> NonNegative<S>

where S: Signed,

pub fn abs(value: S) -> Self

Converts negative input to absolute value.

Example

assert_eq!(*NonNegative::abs (1.0), 1.0);
assert_eq!(*NonNegative::abs (-1.0), 1.0);

pub fn map_abs<F>(self, fun: F) -> Self

where F: FnMut(S) -> S,

Map an operation on the underlying scalar, converting negative result to an absolute value.

Example

assert_eq!(*NonNegative::abs (1.0).map_abs (|x| -2.0 * x), 2.0);

impl NonNegative<f32>

pub const fn new_f32(value: f32) -> Option<Self>

Const constructor for f32

pub const fn noisy_f32(value: f32) -> Self

Const constructor for f32 with assertions

pub const fn unchecked_f32(value: f32) -> Self

Const constructor for f32 with debug assertions

impl NonNegative<f64>

pub const fn new_f64(value: f64) -> Option<Self>

Const constructor for f64

pub const fn noisy_f64(value: f64) -> Self

Const constructor for f64 with assertions

pub const fn unchecked_f64(value: f64) -> Self

Const constructor for f64 with debug assertions

impl<S> NonNegative<S>

pub fn numcast<T>(self) -> Option<NonNegative<T>>

where S: NumCast, T: NumCast,

Trait Implementations

impl<S> Add for NonNegative<S>

where S: Add<Output = S>,

type Output = NonNegative<S>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<S: Ring> Add<NonNegative<S>> for Positive<S>

type Output = Positive<S>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<S: Ring> AddAssign<NonNegative<S>> for Positive<S>

fn add_assign(&mut self, rhs: NonNegative<S>)

Performs the += operation.

impl<S: Clone> Clone for NonNegative<S>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Copy> Copy for NonNegative<S>

impl<S: Debug> Debug for NonNegative<S>

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

Formats the value using the given formatter.

impl<S: Default> Default for NonNegative<S>

fn default() -> NonNegative<S>

Returns the “default value” for a type.

impl<S> Deref for NonNegative<S>

type Target = S

The resulting type after dereferencing.

fn deref(&self) -> &S

Dereferences the value.

impl<S> Display for NonNegative<S>

where S: Display,

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

Formats the value using the given formatter.

impl<S> Div for NonNegative<S>

where S: Div<Output = S>,

type Output = NonNegative<S>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<S: Eq> Eq for NonNegative<S>

impl<S: Ring> From<Positive<S>> for NonNegative<S>

fn from(positive: Positive<S>) -> Self

Converts to this type from the input type.

impl<S: MinMax> MinMax for NonNegative<S>

fn min(self, other: Self) -> Self

fn max(self, other: Self) -> Self

fn clamp(self, min: Self, max: Self) -> Self

impl<S> Mul for NonNegative<S>

where S: Mul<Output = S>,

type Output = NonNegative<S>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<S: Ring> Mul<NonNegative<S>> for Positive<S>

type Output = NonNegative<S>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<S> Mul<Positive<S>> for NonNegative<S>

where S: Mul<Output = S>,

type Output = NonNegative<S>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<S: Ring> MulAssign<NonNegative<S>> for Positive<S>

fn mul_assign(&mut self, rhs: NonNegative<S>)

Performs the *= operation.

impl<S> NumCast for NonNegative<S>

where S: NumCast + PartialOrd + Zero,

fn from<T: ToPrimitive>(n: T) -> Option<NonNegative<S>>

Creates a number from another value that can be converted into a primitive via the ToPrimitive trait. If the source value cannot be represented by the target type, then None is returned.

impl<S: Field> One for NonNegative<S>

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool

where Self: PartialEq,

Returns true if self is equal to the multiplicative identity.

impl<S: PartialEq> PartialEq for NonNegative<S>

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

fn partial_cmp(&self, other: &NonNegative<S>) -> 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<S: Sqrt> Sqrt for NonNegative<S>

fn sqrt(self) -> Self

impl<S> StructuralPartialEq for NonNegative<S>

impl<S> ToPrimitive for NonNegative<S>

where S: ToPrimitive,

fn to_isize(&self) -> Option<isize>

Converts the value of self to an isize. If the value cannot be represented by an isize, then None is returned.

fn to_i8(&self) -> Option<i8>

Converts the value of self to an i8. If the value cannot be represented by an i8, then None is returned.

fn to_i16(&self) -> Option<i16>

Converts the value of self to an i16. If the value cannot be represented by an i16, then None is returned.

fn to_i32(&self) -> Option<i32>

Converts the value of self to an i32. If the value cannot be represented by an i32, then None is returned.

fn to_i64(&self) -> Option<i64>

Converts the value of self to an i64. If the value cannot be represented by an i64, then None is returned.

fn to_usize(&self) -> Option<usize>

Converts the value of self to a usize. If the value cannot be represented by a usize, then None is returned.

fn to_u8(&self) -> Option<u8>

Converts the value of self to a u8. If the value cannot be represented by a u8, then None is returned.

fn to_u16(&self) -> Option<u16>

Converts the value of self to a u16. If the value cannot be represented by a u16, then None is returned.

fn to_u32(&self) -> Option<u32>

Converts the value of self to a u32. If the value cannot be represented by a u32, then None is returned.

fn to_u64(&self) -> Option<u64>

Converts the value of self to a u64. If the value cannot be represented by a u64, then None is returned.

fn to_f32(&self) -> Option<f32>

Converts the value of self to an f32. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f32.

fn to_f64(&self) -> Option<f64>

Converts the value of self to an f64. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f64.

fn to_i128(&self) -> Option<i128>

Converts the value of self to an i128. If the value cannot be represented by an i128 (i64 under the default implementation), then None is returned.

fn to_u128(&self) -> Option<u128>

Converts the value of self to a u128. If the value cannot be represented by a u128 (u64 under the default implementation), then None is returned.

impl<S: Ring> Zero for NonNegative<S>

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.