Struct Product 

pub struct Product<T>(pub T);

Wrapper type for the multiplication monoid.

Product<T> forms a monoid under multiplication (*), useful for computing products, scaling factors, or combining probabilities.

Examples

use algebra_core::{Monoid, Semigroup, Product};

let a = Product(5);
let b = Product(3);
let c = a.combine(&b);
assert_eq!(c, Product(15));

assert_eq!(Product::<i32>::empty(), Product(1));

Combining Probabilities

use algebra_core::{Semigroup, Product};

let prob1 = Product(0.5);
let prob2 = Product(0.5);
let joint_prob = prob1.combine(&prob2);
assert_eq!(joint_prob.0, 0.25);

Tuple Fields

0: T

Trait Implementations

impl<T: Clone> Clone for Product<T>

fn clone(&self) -> Product<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Product<T>

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

Formats the value using the given formatter.

impl<T: Hash> Hash for Product<T>

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<T: Mul<Output = T> + Clone + One> Monoid for Product<T>

fn empty() -> Self

The identity element.

fn concat<I>(iter: I) -> Self

where I: IntoIterator<Item = Self>,

Fold an iterator using combine, starting from empty.

impl<T: Ord> Ord for Product<T>

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

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

fn partial_cmp(&self, other: &Product<T>) -> 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<T: Mul<Output = T> + Clone> Semigroup for Product<T>

fn combine(&self, other: &Self) -> Self

Combine two elements associatively.

fn combine_assign(&mut self, other: &Self)

In-place combine.

impl<T: Mul<Output = T> + Clone + One> CommutativeMonoid for Product<T>

impl<T: Copy> Copy for Product<T>

impl<T: Eq> Eq for Product<T>

impl<T> StructuralPartialEq for Product<T>