Struct arithmetic_eval::arith::ModularArithmetic

pub struct ModularArithmetic<T> { /* private fields */ }

Modular arithmetic on integers.

As an example, ModularArithmetic<T> implements Arithmetic<T> if T is one of unsigned built-in integer types (u8, u16, u32, u64; u128 is excluded because it cannot be extended to double width).

Implementations

impl<T> ModularArithmetic<T>

where T: Clone + PartialEq + NumOps + Unsigned + Zero + One,

pub fn new(modulus: T) -> Self

Creates a new arithmetic with the specified modulus.

Panics

• Panics if modulus is 0 or 1.

pub fn modulus(&self) -> &T

Returns the modulus for this arithmetic.

Trait Implementations

impl Arithmetic<BigUint> for ModularArithmetic<BigUint>

fn add(&self, x: BigUint, y: BigUint) -> Result<BigUint, ArithmeticError>

Adds two values.

fn sub(&self, x: BigUint, y: BigUint) -> Result<BigUint, ArithmeticError>

Subtracts two values.

fn mul(&self, x: BigUint, y: BigUint) -> Result<BigUint, ArithmeticError>

Multiplies two values.

fn div(&self, x: BigUint, y: BigUint) -> Result<BigUint, ArithmeticError>

Divides two values.

fn pow(&self, x: BigUint, y: BigUint) -> Result<BigUint, ArithmeticError>

Raises x to the power of y.

fn neg(&self, x: BigUint) -> Result<BigUint, ArithmeticError>

Negates a value.

fn eq(&self, x: &BigUint, y: &BigUint) -> bool

Checks if two values are equal. Note that equality can be a non-trivial operation; e.g., different numbers may be equal as per modular arithmetic.

impl<T> Arithmetic<T> for ModularArithmetic<T>

where T: Copy + PartialEq + NumOps + Zero + One + DoubleWidth, usize: TryFrom<T>,

fn add(&self, x: T, y: T) -> Result<T, ArithmeticError>

Adds two values.

fn sub(&self, x: T, y: T) -> Result<T, ArithmeticError>

Subtracts two values.

fn mul(&self, x: T, y: T) -> Result<T, ArithmeticError>

Multiplies two values.

fn div(&self, x: T, y: T) -> Result<T, ArithmeticError>

Divides two values.

fn pow(&self, x: T, y: T) -> Result<T, ArithmeticError>

Raises x to the power of y.

fn neg(&self, x: T) -> Result<T, ArithmeticError>

Negates a value.

fn eq(&self, x: &T, y: &T) -> bool

Checks if two values are equal. Note that equality can be a non-trivial operation; e.g., different numbers may be equal as per modular arithmetic.

impl<T: Clone> Clone for ModularArithmetic<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for ModularArithmetic<T>

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

Formats the value using the given formatter.

impl<T: Copy> Copy for ModularArithmetic<T>