Struct RingElement 

pub struct RingElement { /* private fields */ }

Element of the ring Z_m (integers modulo m).

Implementations

impl RingElement

pub fn new(value: u64, modulus: u64) -> Self

Create a new ring element, automatically reducing modulo m.

Panics

Panics if modulus is 0.

pub fn zero(modulus: u64) -> Self

Create the zero element of Z_m.

pub fn one(modulus: u64) -> Self

Create the unit element (1) of Z_m.

pub const fn value(&self) -> u64

Get the underlying value.

pub const fn modulus(&self) -> u64

Get the modulus.

pub fn is_unit(&self) -> bool

Check if this element is a unit (has multiplicative inverse). An element a is a unit iff gcd(a, m) = 1.

pub fn is_zero_divisor(&self) -> bool

Check if this element is a zero divisor. An element a ≠ 0 is a zero divisor iff gcd(a, m) > 1.

pub const fn is_zero(&self) -> bool

Check if this is the zero element.

pub fn inverse(&self) -> Option<Self>

Compute the multiplicative inverse if it exists. Returns None if gcd(value, modulus) != 1.

pub fn scale(&self, scalar: u64) -> Self

Scalar multiplication by a u64 value.

Trait Implementations

impl Add for RingElement

type Output = RingElement

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self

Performs the + operation.

impl Clone for RingElement

fn clone(&self) -> RingElement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RingElement

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RingElement

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for RingElement

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 Mul for RingElement

type Output = RingElement

The resulting type after applying the * operator.

fn mul(self, other: Self) -> Self

Performs the * operation.

impl Neg for RingElement

type Output = RingElement

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq for RingElement

fn eq(&self, other: &RingElement) -> 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 Serialize for RingElement

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for RingElement

type Output = RingElement

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self

Performs the - operation.

impl Copy for RingElement

impl Eq for RingElement

impl StructuralPartialEq for RingElement