Struct NonZero 

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

Non-zero scalars

Implementations

impl<S: Field> NonZero<S>

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

Returns ‘None’ when called with zero.

Example

assert!(NonZero::new (2.0).is_some());
assert!(NonZero::new (0.0).is_none());
assert!(NonZero::new (-2.0).is_some());

pub fn noisy(value: S) -> Self

Panics if called with zero.

Panics

let x = NonZero::noisy (0.0);  // panic!

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

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

Example

assert_eq!(*NonZero::<f64>::one().map_noisy (|x| 0.5 * x), 0.5);

Panics

Panics of the result is zero.

let v = NonZero::<f64>::one().map_noisy (|x| 0.0 * x);  // panic!

impl<S> NonZero<S>

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

where S: NumCast, T: NumCast,

Trait Implementations

impl<S: Clone> Clone for NonZero<S>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for NonZero<S>

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

Formats the value using the given formatter.

impl<S: Default> Default for NonZero<S>

fn default() -> NonZero<S>

Returns the “default value” for a type.

impl<S: Field> Deref for NonZero<S>

type Target = S

The resulting type after dereferencing.

fn deref(&self) -> &S

Dereferences the value.

impl<S: Field> Mul for NonZero<S>

type Output = NonZero<S>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<S: Field> One for NonZero<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 NonZero<S>

fn eq(&self, other: &NonZero<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 NonZero<S>

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

impl<S: Field> Eq for NonZero<S>

impl<S> StructuralPartialEq for NonZero<S>