Struct modular_math::ModMath

pub struct ModMath { /* private fields */ }

ModMath is a struct that provides modular arithmetic operations.

It operates on unsigned 256-bit integers (U256) and performs operations under a given modulus. The modulus is provided when creating a new ModMath instance and cannot be zero.

Implementations

impl ModMath

pub fn new(modulus: U256) -> Self

Creates a new ModMath instance with the given modulus.

Panics

Panics if the modulus is zero.

pub fn modulus(&self, a: U256) -> U256

pub fn add(&self, a: U256, b: U256) -> U256

Adds two U256 numbers under the modulus.

pub fn sub(&self, a: U256, b: U256) -> U256

Subtracts the second U256 number from the first one under the modulus.

pub fn mul(&self, a: U256, b: U256) -> U256

Multiplies two U256 numbers under the modulus.

pub fn exp(&self, base: U256, exponent: U256) -> U256

Raises the base to the power of the exponent under the modulus.

pub fn inv(&self, a: U256) -> Option<U256>

Calculates the modular multiplicative inverse of a U256 number under the modulus.

Returns None if the inverse does not exist.

pub fn div(&self, a: U256, b: U256) -> U256

Divides the first U256 number by the second one under the modulus.

Panics

Panics if the second number is zero or if its inverse does not exist under the modulus.

pub fn eq(&self, a: U256, b: U256) -> bool

Checks if two U256 numbers are equivalent under the modulus.

pub fn square(&self, a: U256) -> U256

Squares a given U256 number under modulus

pub fn sqrt(&self, a: U256) -> U256