1.0.0[][src]Trait core::ops::Mul

#[lang = "mul"]
pub trait Mul<Rhs = Self> { type Output;
#[must_use]
fn mul(self, rhs: Rhs) -> Self::Output; }

The multiplication operator *.

Note that Rhs is Self by default, but this is not mandatory.

Examples

Multipliable rational numbers

use std::ops::Mul;

// By the fundamental theorem of arithmetic, rational numbers in lowest
// terms are unique. So, by keeping `Rational`s in reduced form, we can
// derive `Eq` and `PartialEq`.
#[derive(Debug, Eq, PartialEq)]
struct Rational {
    numerator: usize,
    denominator: usize,
}

impl Rational {
    fn new(numerator: usize, denominator: usize) -> Self {
        if denominator == 0 {
            panic!("Zero is an invalid denominator!");
        }

        // Reduce to lowest terms by dividing by the greatest common
        // divisor.
        let gcd = gcd(numerator, denominator);
        Rational {
            numerator: numerator / gcd,
            denominator: denominator / gcd,
        }
    }
}

impl Mul for Rational {
    // The multiplication of rational numbers is a closed operation.
    type Output = Self;

    fn mul(self, rhs: Self) -> Self {
        let numerator = self.numerator * rhs.numerator;
        let denominator = self.denominator * rhs.denominator;
        Rational::new(numerator, denominator)
    }
}

// Euclid's two-thousand-year-old algorithm for finding the greatest common
// divisor.
fn gcd(x: usize, y: usize) -> usize {
    let mut x = x;
    let mut y = y;
    while y != 0 {
        let t = y;
        y = x % y;
        x = t;
    }
    x
}

assert_eq!(Rational::new(1, 2), Rational::new(2, 4));
assert_eq!(Rational::new(2, 3) * Rational::new(3, 4),
           Rational::new(1, 2));Run

Multiplying vectors by scalars as in linear algebra

use std::ops::Mul;

struct Scalar { value: usize }

#[derive(Debug, PartialEq)]
struct Vector { value: Vec<usize> }

impl Mul<Scalar> for Vector {
    type Output = Self;

    fn mul(self, rhs: Scalar) -> Self::Output {
        Vector { value: self.value.iter().map(|v| v * rhs.value).collect() }
    }
}

let vector = Vector { value: vec![2, 4, 6] };
let scalar = Scalar { value: 3 };
assert_eq!(vector * scalar, Vector { value: vec![6, 12, 18] });Run

Associated Types

type Output

The resulting type after applying the * operator.

Loading content...

Required methods

#[must_use]
fn mul(self, rhs: Rhs) -> Self::Output

Performs the * operation.

Loading content...

Implementors

impl Mul<Wrapping<i128>> for Wrapping<i128>[src]

type Output = Wrapping<i128>

impl Mul<Wrapping<i16>> for Wrapping<i16>[src]

type Output = Wrapping<i16>

impl Mul<Wrapping<i32>> for Wrapping<i32>[src]

type Output = Wrapping<i32>

impl Mul<Wrapping<i64>> for Wrapping<i64>[src]

type Output = Wrapping<i64>

impl Mul<Wrapping<i8>> for Wrapping<i8>[src]

type Output = Wrapping<i8>

impl Mul<Wrapping<isize>> for Wrapping<isize>[src]

type Output = Wrapping<isize>

impl Mul<Wrapping<u128>> for Wrapping<u128>[src]

type Output = Wrapping<u128>

impl Mul<Wrapping<u16>> for Wrapping<u16>[src]

type Output = Wrapping<u16>

impl Mul<Wrapping<u32>> for Wrapping<u32>[src]

type Output = Wrapping<u32>

impl Mul<Wrapping<u64>> for Wrapping<u64>[src]

type Output = Wrapping<u64>

impl Mul<Wrapping<u8>> for Wrapping<u8>[src]

type Output = Wrapping<u8>

impl Mul<Wrapping<usize>> for Wrapping<usize>[src]

type Output = Wrapping<usize>

impl Mul<Duration> for u32[src]

type Output = Duration

impl Mul<f32> for f32[src]

type Output = f32

impl Mul<f64> for f64[src]

type Output = f64

impl Mul<i128> for i128[src]

type Output = i128

impl Mul<i16> for i16[src]

type Output = i16

impl Mul<i32> for i32[src]

type Output = i32

impl Mul<i64> for i64[src]

type Output = i64

impl Mul<i8> for i8[src]

type Output = i8

impl Mul<isize> for isize[src]

type Output = isize

impl Mul<u32> for Duration[src]

type Output = Duration

impl Mul<u128> for u128[src]

type Output = u128

impl Mul<u16> for u16[src]

type Output = u16

impl Mul<u32> for u32[src]

type Output = u32

impl Mul<u64> for u64[src]

type Output = u64

impl Mul<u8> for u8[src]

type Output = u8

impl Mul<usize> for usize[src]

type Output = usize

impl<'_> Mul<&'_ Wrapping<i128>> for Wrapping<i128>[src]

type Output = <Wrapping<i128> as Mul<Wrapping<i128>>>::Output

impl<'_> Mul<&'_ Wrapping<i16>> for Wrapping<i16>[src]

type Output = <Wrapping<i16> as Mul<Wrapping<i16>>>::Output

impl<'_> Mul<&'_ Wrapping<i32>> for Wrapping<i32>[src]

type Output = <Wrapping<i32> as Mul<Wrapping<i32>>>::Output

impl<'_> Mul<&'_ Wrapping<i64>> for Wrapping<i64>[src]

type Output = <Wrapping<i64> as Mul<Wrapping<i64>>>::Output

impl<'_> Mul<&'_ Wrapping<i8>> for Wrapping<i8>[src]

type Output = <Wrapping<i8> as Mul<Wrapping<i8>>>::Output

impl<'_> Mul<&'_ Wrapping<isize>> for Wrapping<isize>[src]

type Output = <Wrapping<isize> as Mul<Wrapping<isize>>>::Output

impl<'_> Mul<&'_ Wrapping<u128>> for Wrapping<u128>[src]

type Output = <Wrapping<u128> as Mul<Wrapping<u128>>>::Output

impl<'_> Mul<&'_ Wrapping<u16>> for Wrapping<u16>[src]

type Output = <Wrapping<u16> as Mul<Wrapping<u16>>>::Output

impl<'_> Mul<&'_ Wrapping<u32>> for Wrapping<u32>[src]

type Output = <Wrapping<u32> as Mul<Wrapping<u32>>>::Output

impl<'_> Mul<&'_ Wrapping<u64>> for Wrapping<u64>[src]

type Output = <Wrapping<u64> as Mul<Wrapping<u64>>>::Output

impl<'_> Mul<&'_ Wrapping<u8>> for Wrapping<u8>[src]

type Output = <Wrapping<u8> as Mul<Wrapping<u8>>>::Output

impl<'_> Mul<&'_ Wrapping<usize>> for Wrapping<usize>[src]

type Output = <Wrapping<usize> as Mul<Wrapping<usize>>>::Output

impl<'_> Mul<&'_ f32> for f32[src]

type Output = <f32 as Mul<f32>>::Output

impl<'_> Mul<&'_ f64> for f64[src]

type Output = <f64 as Mul<f64>>::Output

impl<'_> Mul<&'_ i128> for i128[src]

type Output = <i128 as Mul<i128>>::Output

impl<'_> Mul<&'_ i16> for i16[src]

type Output = <i16 as Mul<i16>>::Output

impl<'_> Mul<&'_ i32> for i32[src]

type Output = <i32 as Mul<i32>>::Output

impl<'_> Mul<&'_ i64> for i64[src]

type Output = <i64 as Mul<i64>>::Output

impl<'_> Mul<&'_ i8> for i8[src]

type Output = <i8 as Mul<i8>>::Output

impl<'_> Mul<&'_ isize> for isize[src]

type Output = <isize as Mul<isize>>::Output

impl<'_> Mul<&'_ u128> for u128[src]

type Output = <u128 as Mul<u128>>::Output

impl<'_> Mul<&'_ u16> for u16[src]

type Output = <u16 as Mul<u16>>::Output

impl<'_> Mul<&'_ u32> for u32[src]

type Output = <u32 as Mul<u32>>::Output

impl<'_> Mul<&'_ u64> for u64[src]

type Output = <u64 as Mul<u64>>::Output

impl<'_> Mul<&'_ u8> for u8[src]

type Output = <u8 as Mul<u8>>::Output

impl<'_> Mul<&'_ usize> for usize[src]

type Output = <usize as Mul<usize>>::Output

impl<'_, '_> Mul<&'_ Wrapping<i128>> for &'_ Wrapping<i128>[src]

type Output = <Wrapping<i128> as Mul<Wrapping<i128>>>::Output

impl<'_, '_> Mul<&'_ Wrapping<i16>> for &'_ Wrapping<i16>[src]

type Output = <Wrapping<i16> as Mul<Wrapping<i16>>>::Output

impl<'_, '_> Mul<&'_ Wrapping<i32>> for &'_ Wrapping<i32>[src]

type Output = <Wrapping<i32> as Mul<Wrapping<i32>>>::Output

impl<'_, '_> Mul<&'_ Wrapping<i64>> for &'_ Wrapping<i64>[src]

type Output = <Wrapping<i64> as Mul<Wrapping<i64>>>::Output

impl<'_, '_> Mul<&'_ Wrapping<i8>> for &'_ Wrapping<i8>[src]

type Output = <Wrapping<i8> as Mul<Wrapping<i8>>>::Output

impl<'_, '_> Mul<&'_ Wrapping<isize>> for &'_ Wrapping<isize>[src]

type Output = <Wrapping<isize> as Mul<Wrapping<isize>>>::Output

impl<'_, '_> Mul<&'_ Wrapping<u128>> for &'_ Wrapping<u128>[src]

type Output = <Wrapping<u128> as Mul<Wrapping<u128>>>::Output

impl<'_, '_> Mul<&'_ Wrapping<u16>> for &'_ Wrapping<u16>[src]

type Output = <Wrapping<u16> as Mul<Wrapping<u16>>>::Output

impl<'_, '_> Mul<&'_ Wrapping<u32>> for &'_ Wrapping<u32>[src]

type Output = <Wrapping<u32> as Mul<Wrapping<u32>>>::Output

impl<'_, '_> Mul<&'_ Wrapping<u64>> for &'_ Wrapping<u64>[src]

type Output = <Wrapping<u64> as Mul<Wrapping<u64>>>::Output

impl<'_, '_> Mul<&'_ Wrapping<u8>> for &'_ Wrapping<u8>[src]

type Output = <Wrapping<u8> as Mul<Wrapping<u8>>>::Output

impl<'_, '_> Mul<&'_ Wrapping<usize>> for &'_ Wrapping<usize>[src]

type Output = <Wrapping<usize> as Mul<Wrapping<usize>>>::Output

impl<'_, '_> Mul<&'_ f32> for &'_ f32[src]

type Output = <f32 as Mul<f32>>::Output

impl<'_, '_> Mul<&'_ f64> for &'_ f64[src]

type Output = <f64 as Mul<f64>>::Output

impl<'_, '_> Mul<&'_ i128> for &'_ i128[src]

type Output = <i128 as Mul<i128>>::Output

impl<'_, '_> Mul<&'_ i16> for &'_ i16[src]

type Output = <i16 as Mul<i16>>::Output

impl<'_, '_> Mul<&'_ i32> for &'_ i32[src]

type Output = <i32 as Mul<i32>>::Output

impl<'_, '_> Mul<&'_ i64> for &'_ i64[src]

type Output = <i64 as Mul<i64>>::Output

impl<'_, '_> Mul<&'_ i8> for &'_ i8[src]

type Output = <i8 as Mul<i8>>::Output

impl<'_, '_> Mul<&'_ isize> for &'_ isize[src]

type Output = <isize as Mul<isize>>::Output

impl<'_, '_> Mul<&'_ u128> for &'_ u128[src]

type Output = <u128 as Mul<u128>>::Output

impl<'_, '_> Mul<&'_ u16> for &'_ u16[src]

type Output = <u16 as Mul<u16>>::Output

impl<'_, '_> Mul<&'_ u32> for &'_ u32[src]

type Output = <u32 as Mul<u32>>::Output

impl<'_, '_> Mul<&'_ u64> for &'_ u64[src]

type Output = <u64 as Mul<u64>>::Output

impl<'_, '_> Mul<&'_ u8> for &'_ u8[src]

type Output = <u8 as Mul<u8>>::Output

impl<'_, '_> Mul<&'_ usize> for &'_ usize[src]

type Output = <usize as Mul<usize>>::Output

impl<'a> Mul<Wrapping<i128>> for &'a Wrapping<i128>[src]

type Output = <Wrapping<i128> as Mul<Wrapping<i128>>>::Output

impl<'a> Mul<Wrapping<i16>> for &'a Wrapping<i16>[src]

type Output = <Wrapping<i16> as Mul<Wrapping<i16>>>::Output

impl<'a> Mul<Wrapping<i32>> for &'a Wrapping<i32>[src]

type Output = <Wrapping<i32> as Mul<Wrapping<i32>>>::Output

impl<'a> Mul<Wrapping<i64>> for &'a Wrapping<i64>[src]

type Output = <Wrapping<i64> as Mul<Wrapping<i64>>>::Output

impl<'a> Mul<Wrapping<i8>> for &'a Wrapping<i8>[src]

type Output = <Wrapping<i8> as Mul<Wrapping<i8>>>::Output

impl<'a> Mul<Wrapping<isize>> for &'a Wrapping<isize>[src]

type Output = <Wrapping<isize> as Mul<Wrapping<isize>>>::Output

impl<'a> Mul<Wrapping<u128>> for &'a Wrapping<u128>[src]

type Output = <Wrapping<u128> as Mul<Wrapping<u128>>>::Output

impl<'a> Mul<Wrapping<u16>> for &'a Wrapping<u16>[src]

type Output = <Wrapping<u16> as Mul<Wrapping<u16>>>::Output

impl<'a> Mul<Wrapping<u32>> for &'a Wrapping<u32>[src]

type Output = <Wrapping<u32> as Mul<Wrapping<u32>>>::Output

impl<'a> Mul<Wrapping<u64>> for &'a Wrapping<u64>[src]

type Output = <Wrapping<u64> as Mul<Wrapping<u64>>>::Output

impl<'a> Mul<Wrapping<u8>> for &'a Wrapping<u8>[src]

type Output = <Wrapping<u8> as Mul<Wrapping<u8>>>::Output

impl<'a> Mul<Wrapping<usize>> for &'a Wrapping<usize>[src]

type Output = <Wrapping<usize> as Mul<Wrapping<usize>>>::Output

impl<'a> Mul<f32> for &'a f32[src]

type Output = <f32 as Mul<f32>>::Output

impl<'a> Mul<f64> for &'a f64[src]

type Output = <f64 as Mul<f64>>::Output

impl<'a> Mul<i128> for &'a i128[src]

type Output = <i128 as Mul<i128>>::Output

impl<'a> Mul<i16> for &'a i16[src]

type Output = <i16 as Mul<i16>>::Output

impl<'a> Mul<i32> for &'a i32[src]

type Output = <i32 as Mul<i32>>::Output

impl<'a> Mul<i64> for &'a i64[src]

type Output = <i64 as Mul<i64>>::Output

impl<'a> Mul<i8> for &'a i8[src]

type Output = <i8 as Mul<i8>>::Output

impl<'a> Mul<isize> for &'a isize[src]

type Output = <isize as Mul<isize>>::Output

impl<'a> Mul<u128> for &'a u128[src]

type Output = <u128 as Mul<u128>>::Output

impl<'a> Mul<u16> for &'a u16[src]

type Output = <u16 as Mul<u16>>::Output

impl<'a> Mul<u32> for &'a u32[src]

type Output = <u32 as Mul<u32>>::Output

impl<'a> Mul<u64> for &'a u64[src]

type Output = <u64 as Mul<u64>>::Output

impl<'a> Mul<u8> for &'a u8[src]

type Output = <u8 as Mul<u8>>::Output

impl<'a> Mul<usize> for &'a usize[src]

type Output = <usize as Mul<usize>>::Output

Loading content...