Struct NonNegative

pub struct NonNegative { /* private fields */ }

NonNegative, a wrapper for a f64 value, ensuring it is always >= 0

Implementations

impl NonNegative

pub fn new(val: f64) -> Result<NonNegative>

Creates a new NonNegative if input >= 0, fails otherwise

pub fn zero() -> NonNegative

Creates a new NonNegative with value 0

pub fn one() -> NonNegative

Creates a new NonNegative with value 1

pub fn get(&self) -> f64

Returns the wrapped value

pub fn sqrt(&self) -> NonNegative

Returns the square root

Trait Implementations

impl Add<NonNegative> for Positive

type Output = Positive

The resulting type after applying the + operator.

fn add(self, other: NonNegative) -> Positive

Performs the + operation.

impl Add<Positive> for NonNegative

type Output = NonNegative

The resulting type after applying the + operator.

fn add(self, other: Positive) -> NonNegative

Performs the + operation.

impl Add for NonNegative

type Output = NonNegative

The resulting type after applying the + operator.

fn add(self, other: NonNegative) -> NonNegative

Performs the + operation.

impl AddAssign<NonNegative> for Positive

fn add_assign(&mut self, other: NonNegative)

Performs the += operation.

impl AddAssign<Positive> for NonNegative

fn add_assign(&mut self, other: Positive)

Performs the += operation.

impl AddAssign for NonNegative

fn add_assign(&mut self, other: NonNegative)

Performs the += operation.

impl AsRef<f64> for NonNegative

fn as_ref(&self) -> &f64

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for NonNegative

fn clone(&self) -> NonNegative

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NonNegative

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

Formats the value using the given formatter.

impl Default for NonNegative

fn default() -> Self

Returns the “default value” for a type.

impl Display for NonNegative

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

Formats the value using the given formatter.

impl Div<NonNegative> for Positive

type Output = NonNegative

The resulting type after applying the / operator.

fn div(self, other: NonNegative) -> NonNegative

Performs the / operation.

impl Div<Positive> for NonNegative

type Output = NonNegative

The resulting type after applying the / operator.

fn div(self, other: Positive) -> NonNegative

Performs the / operation.

impl Div for NonNegative

type Output = NonNegative

The resulting type after applying the / operator.

fn div(self, other: NonNegative) -> NonNegative

Performs the / operation.

impl DivAssign<Positive> for NonNegative

fn div_assign(&mut self, other: Positive)

Performs the /= operation.

impl DivAssign for NonNegative

fn div_assign(&mut self, other: NonNegative)

Performs the /= operation.

impl From<Positive> for NonNegative

fn from(x: Positive) -> Self

Converts to this type from the input type.

impl Hash for NonNegative

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Into<f64> for NonNegative

fn into(self) -> f64

Converts this type into the (usually inferred) input type.

impl Mul<NonNegative> for Positive

type Output = NonNegative

The resulting type after applying the * operator.

fn mul(self, other: NonNegative) -> NonNegative

Performs the * operation.

impl Mul<Positive> for NonNegative

type Output = NonNegative

The resulting type after applying the * operator.

fn mul(self, other: Positive) -> NonNegative

Performs the * operation.

impl Mul for NonNegative

type Output = NonNegative

The resulting type after applying the * operator.

fn mul(self, other: NonNegative) -> NonNegative

Performs the * operation.

impl MulAssign<Positive> for NonNegative

fn mul_assign(&mut self, other: Positive)

Performs the *= operation.

impl MulAssign for NonNegative

fn mul_assign(&mut self, other: NonNegative)

Performs the *= operation.

impl PartialEq for NonNegative

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

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

impl Eq for NonNegative

impl StructuralPartialEq for NonNegative