Struct NonNegative

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

Non-negative scalars (may be zero)

Implementations

impl<S: Ring> NonNegative<S>

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 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 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_abs(self, fun: fn(S) -> S) -> Self

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);

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

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>

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

where S: NumCast, T: NumCast,

Trait Implementations

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> Add for NonNegative<S>

type Output = NonNegative<S>

The resulting type after applying the + operator.

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

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: 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: Ring> Deref for NonNegative<S>

type Target = S

The resulting type after dereferencing.

fn deref(&self) -> &S

Dereferences the value.

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

type Output = NonNegative<S>

The resulting type after applying the / operator.

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

Performs the / operation.

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: 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: Ring> Mul<Positive<S>> for NonNegative<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> Mul for NonNegative<S>

type Output = NonNegative<S>

The resulting type after applying the * operator.

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

Performs the * operation.

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: 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.

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

impl<S> StructuralPartialEq for NonNegative<S>