Trait Modulus

pub trait Modulus {
    // Required method
    fn modulus(self, divisor: Self) -> Self;
}

Provides a trait for the canonical modulus operation since % is technically the remainder operation

Required Methods

fn modulus(self, divisor: Self) -> Self

Performs a canonical modulus operation between self and divisor.

Examples

use statrs::euclid::Modulus;

let x = 4i64.modulus(5);
assert_eq!(x, 4);

let y = -4i64.modulus(5);
assert_eq!(x, 4);

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl Modulus for f32

fn modulus(self, divisor: f32) -> f32

impl Modulus for f64

fn modulus(self, divisor: f64) -> f64

impl Modulus for i32

fn modulus(self, divisor: i32) -> i32

impl Modulus for i64

fn modulus(self, divisor: i64) -> i64

impl Modulus for u32

fn modulus(self, divisor: u32) -> u32

impl Modulus for u64

fn modulus(self, divisor: u64) -> u64

Implementors