Struct NormalSigned

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

Scalars in the closed interval [-1, 1]

Implementations

impl<S: Field> NormalSigned<S>

pub fn zero() -> Self

pub fn is_zero(&self) -> bool

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

Returns ‘None’ when called with a value outside of the closed interval [-1,1].

Example

assert!(NormalSigned::new (2.0).is_none());
assert!(NormalSigned::new (1.0).is_some());
assert!(NormalSigned::new (0.5).is_some());
assert!(NormalSigned::new (0.0).is_some());
assert!(NormalSigned::new (-1.0).is_some());
assert!(NormalSigned::new (-2.0).is_none());

pub fn clamp(value: S) -> Self

Clamps to the closed interval [-1,1]

Example

assert_eq!(*NormalSigned::clamp (2.0), 1.0);
assert_eq!(*NormalSigned::clamp (-2.0), -1.0);

pub fn noisy(value: S) -> Self

Panics if outside the closed interval [-1,1]

Panics

let x = NormalSigned::noisy (-2.0);   // panic!

let x = NormalSigned::noisy (2.0);    // panic!

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

Map an operation on the underlying scalar, clamping results to the closed interval [-1,1].

Example

assert_eq!(*NormalSigned::<f64>::one().map_clamp (|x|  2.0 * x),  1.0);
assert_eq!(*NormalSigned::<f64>::one().map_clamp (|x| -2.0 * x), -1.0);

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

Map an operation on the underlying scalar, panicking if the result is outside the interval [-1, 1]

Example

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

Panics

Panics of the result is outside [-1, 1]:

let v = NormalSigned::<f64>::one().map_noisy (|x| -2.0 * x);  // panic!

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

impl<S> NormalSigned<S>

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

where S: NumCast, T: NumCast,

Trait Implementations

impl<S: Clone> Clone for NormalSigned<S>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for NormalSigned<S>

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

Formats the value using the given formatter.

impl<S: Default> Default for NormalSigned<S>

fn default() -> NormalSigned<S>

Returns the “default value” for a type.

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

type Target = S

The resulting type after dereferencing.

fn deref(&self) -> &S

Dereferences the value.

impl<S: Field> From<Normalized<S>> for NormalSigned<S>

fn from(Normalized: Normalized<S>) -> Self

Converts to this type from the input type.

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

type Output = NormalSigned<S>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<S: Field> Neg for NormalSigned<S>

type Output = NormalSigned<S>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

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

fn cmp(&self, rhs: &Self) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<S: PartialEq> PartialEq for NormalSigned<S>

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

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

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

impl<S> StructuralPartialEq for NormalSigned<S>