Struct Additive

#[repr(transparent)]
pub struct Additive<M>(pub M);

Write a monoid additively.

This is usually done if the operation is commutative, but that isn’t required here.

Tuple Fields

0: M

Trait Implementations

impl<M: Monoid> Add for Additive<M>

type Output = Additive<M>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<M: Clone> Clone for Additive<M>

fn clone(&self) -> Additive<M>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M: Debug> Debug for Additive<M>

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

Formats the value using the given formatter.

impl<M: Default> Default for Additive<M>

fn default() -> Additive<M>

Returns the “default value” for a type.

impl<M: Hash> Hash for Additive<M>

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<M: Ord> Ord for Additive<M>

fn cmp(&self, other: &Additive<M>) -> 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<M: PartialEq> PartialEq for Additive<M>

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

fn partial_cmp(&self, other: &Additive<M>) -> 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<M: Monoid> Sum<M> for Additive<M>

fn sum<I: Iterator<Item = M>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl<M: Monoid> Sum for Additive<M>

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl<M: Monoid + Eq> Zero for Additive<M>

Available on crate feature num-traits only.

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl<M: Copy> Copy for Additive<M>

impl<M: Eq> Eq for Additive<M>

impl<M> StructuralPartialEq for Additive<M>