pub struct NonNegative<S>(/* private fields */);
Expand description
Non-negative scalars (may be zero)
Implementations§
Source§impl<S: Ring> NonNegative<S>
impl<S: Ring> NonNegative<S>
Sourcepub fn new(value: S) -> Option<Self>
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());
Sourcepub fn abs(value: S) -> Self
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);
Sourcepub fn unchecked(value: S) -> Self
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!
Sourcepub fn map_abs(self, fun: fn(S) -> S) -> Self
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);
Source§impl<S> NonNegative<S>
impl<S> NonNegative<S>
Trait Implementations§
Source§impl<S: Ring> Add for NonNegative<S>
impl<S: Ring> Add for NonNegative<S>
Source§impl<S: Clone> Clone for NonNegative<S>
impl<S: Clone> Clone for NonNegative<S>
Source§fn clone(&self) -> NonNegative<S>
fn clone(&self) -> NonNegative<S>
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moreSource§impl<S: Debug> Debug for NonNegative<S>
impl<S: Debug> Debug for NonNegative<S>
Source§impl<S: Default> Default for NonNegative<S>
impl<S: Default> Default for NonNegative<S>
Source§fn default() -> NonNegative<S>
fn default() -> NonNegative<S>
Returns the “default value” for a type. Read more
Source§impl<S: Ring> Deref for NonNegative<S>
impl<S: Ring> Deref for NonNegative<S>
Source§impl<S: Field> Div for NonNegative<S>
impl<S: Field> Div for NonNegative<S>
Source§impl<S: Ring> Mul<NonNegative<S>> for Positive<S>
impl<S: Ring> Mul<NonNegative<S>> for Positive<S>
Source§type Output = NonNegative<S>
type Output = NonNegative<S>
The resulting type after applying the
*
operator.Source§impl<S: Ring> Mul for NonNegative<S>
impl<S: Ring> Mul for NonNegative<S>
Source§impl<S: Field> One for NonNegative<S>
impl<S: Field> One for NonNegative<S>
Source§impl<S: PartialEq> PartialEq for NonNegative<S>
impl<S: PartialEq> PartialEq for NonNegative<S>
Source§impl<S: PartialOrd> PartialOrd for NonNegative<S>
impl<S: PartialOrd> PartialOrd for NonNegative<S>
Source§impl<S: Ring> Zero for NonNegative<S>
impl<S: Ring> Zero for NonNegative<S>
impl<S: Copy> Copy for NonNegative<S>
impl<S> StructuralPartialEq for NonNegative<S>
Auto Trait Implementations§
impl<S> Freeze for NonNegative<S>where
S: Freeze,
impl<S> RefUnwindSafe for NonNegative<S>where
S: RefUnwindSafe,
impl<S> Send for NonNegative<S>where
S: Send,
impl<S> Sync for NonNegative<S>where
S: Sync,
impl<S> Unpin for NonNegative<S>where
S: Unpin,
impl<S> UnwindSafe for NonNegative<S>where
S: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CheckedAs for T
impl<T> CheckedAs for T
Source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Casts the value.
Source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
Source§fn checked_cast_from(src: Src) -> Option<Dst>
fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<Src, Dst> LosslessTryInto<Dst> for Srcwhere
Dst: LosslessTryFrom<Src>,
impl<Src, Dst> LosslessTryInto<Dst> for Srcwhere
Dst: LosslessTryFrom<Src>,
Source§fn lossless_try_into(self) -> Option<Dst>
fn lossless_try_into(self) -> Option<Dst>
Performs the conversion.
Source§impl<Src, Dst> LossyInto<Dst> for Srcwhere
Dst: LossyFrom<Src>,
impl<Src, Dst> LossyInto<Dst> for Srcwhere
Dst: LossyFrom<Src>,
Source§fn lossy_into(self) -> Dst
fn lossy_into(self) -> Dst
Performs the conversion.
Source§impl<T> OverflowingAs for T
impl<T> OverflowingAs for T
Source§fn overflowing_as<Dst>(self) -> (Dst, bool)where
T: OverflowingCast<Dst>,
fn overflowing_as<Dst>(self) -> (Dst, bool)where
T: OverflowingCast<Dst>,
Casts the value.
Source§impl<Src, Dst> OverflowingCastFrom<Src> for Dstwhere
Src: OverflowingCast<Dst>,
impl<Src, Dst> OverflowingCastFrom<Src> for Dstwhere
Src: OverflowingCast<Dst>,
Source§fn overflowing_cast_from(src: Src) -> (Dst, bool)
fn overflowing_cast_from(src: Src) -> (Dst, bool)
Casts the value.
Source§impl<T> SaturatingAs for T
impl<T> SaturatingAs for T
Source§fn saturating_as<Dst>(self) -> Dstwhere
T: SaturatingCast<Dst>,
fn saturating_as<Dst>(self) -> Dstwhere
T: SaturatingCast<Dst>,
Casts the value.
Source§impl<Src, Dst> SaturatingCastFrom<Src> for Dstwhere
Src: SaturatingCast<Dst>,
impl<Src, Dst> SaturatingCastFrom<Src> for Dstwhere
Src: SaturatingCast<Dst>,
Source§fn saturating_cast_from(src: Src) -> Dst
fn saturating_cast_from(src: Src) -> Dst
Casts the value.
Source§impl<T> UnwrappedAs for T
impl<T> UnwrappedAs for T
Source§fn unwrapped_as<Dst>(self) -> Dstwhere
T: UnwrappedCast<Dst>,
fn unwrapped_as<Dst>(self) -> Dstwhere
T: UnwrappedCast<Dst>,
Casts the value.
Source§impl<Src, Dst> UnwrappedCastFrom<Src> for Dstwhere
Src: UnwrappedCast<Dst>,
impl<Src, Dst> UnwrappedCastFrom<Src> for Dstwhere
Src: UnwrappedCast<Dst>,
Source§fn unwrapped_cast_from(src: Src) -> Dst
fn unwrapped_cast_from(src: Src) -> Dst
Casts the value.
Source§impl<T> WrappingAs for T
impl<T> WrappingAs for T
Source§fn wrapping_as<Dst>(self) -> Dstwhere
T: WrappingCast<Dst>,
fn wrapping_as<Dst>(self) -> Dstwhere
T: WrappingCast<Dst>,
Casts the value.
Source§impl<Src, Dst> WrappingCastFrom<Src> for Dstwhere
Src: WrappingCast<Dst>,
impl<Src, Dst> WrappingCastFrom<Src> for Dstwhere
Src: WrappingCast<Dst>,
Source§fn wrapping_cast_from(src: Src) -> Dst
fn wrapping_cast_from(src: Src) -> Dst
Casts the value.