Struct NormalSigned

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

Scalars in the closed interval [-1, 1]

Implementations§

Source§

impl<S: Field> NormalSigned<S>

Source

pub fn zero() -> Self

Source

pub fn is_zero(&self) -> bool

Source

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

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

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!
Source

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

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!
Source§

impl<S> NormalSigned<S>

Source

pub fn numcast<T>(self) -> Option<NormalSigned<T>>
where S: NumCast, T: NumCast,

Trait Implementations§

Source§

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

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn default() -> NormalSigned<S>

Returns the “default value” for a type. Read more
Source§

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

Source§

type Target = S

The resulting type after dereferencing.
Source§

fn deref(&self) -> &S

Dereferences the value.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

type Output = NormalSigned<S>

The resulting type after applying the * operator.
Source§

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

Performs the * operation. Read more
Source§

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

Source§

type Output = NormalSigned<S>

The resulting type after applying the - operator.
Source§

fn neg(self) -> Self::Output

Performs the unary - operation. Read more
Source§

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

Source§

fn one() -> Self

Returns the multiplicative identity element of Self, 1. Read more
Source§

fn set_one(&mut self)

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

fn is_one(&self) -> bool
where Self: PartialEq,

Returns true if self is equal to the multiplicative identity. Read more
Source§

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

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

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

Source§

fn eq(&self, other: &NormalSigned<S>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<S: PartialOrd> PartialOrd for NormalSigned<S>

Source§

fn partial_cmp(&self, other: &NormalSigned<S>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<S: Copy> Copy for NormalSigned<S>

Source§

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

Source§

impl<S> StructuralPartialEq for NormalSigned<S>

Auto Trait Implementations§

§

impl<S> Freeze for NormalSigned<S>
where S: Freeze,

§

impl<S> RefUnwindSafe for NormalSigned<S>
where S: RefUnwindSafe,

§

impl<S> Send for NormalSigned<S>
where S: Send,

§

impl<S> Sync for NormalSigned<S>
where S: Sync,

§

impl<S> Unpin for NormalSigned<S>
where S: Unpin,

§

impl<S> UnwindSafe for NormalSigned<S>
where S: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Src, Dst> LosslessTryInto<Dst> for Src
where Dst: LosslessTryFrom<Src>,

Source§

fn lossless_try_into(self) -> Option<Dst>

Performs the conversion.
Source§

impl<Src, Dst> LossyInto<Dst> for Src
where Dst: LossyFrom<Src>,

Source§

fn lossy_into(self) -> Dst

Performs the conversion.
Source§

impl<T> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> MaybeSerDes for T