Struct Zq 

pub struct Zq<const N: usize, B: ArithmeticBackend<N>> {
    pub val: Uint<N>,
    /* private fields */
}

A ring of integers mod q.

Fields

val: Uint<N>

The value of the Zq stored in its backend-specific representation. For example, using the BarrettBackend, which is the standard representation but with a Montgomery backend, this will be stored in Montgomery form.

Implementations

impl<const N: usize, B: ArithmeticBackend<N>> Zq<N, B>

pub fn into_bigint(self) -> Uint<N>

Converts the element in Zq over the range [0, q) to a canonical integer with the same number of limbs in the same range.

Trait Implementations

impl<const N: usize, B> Add<&Zq<N, B>> for &Zq<N, B>

where B: ArithmeticBackend<N>,

type Output = Zq<N, B>

The resulting type after applying the + operator.

fn add(self, rhs: &Zq<N, B>) -> Self::Output

Performs the + operation.

impl<const N: usize, B> Add<&Zq<N, B>> for Zq<N, B>

where B: ArithmeticBackend<N>,

type Output = Zq<N, B>

The resulting type after applying the + operator.

fn add(self, rhs: &Zq<N, B>) -> Self::Output

Performs the + operation.

impl<const N: usize, B> Add<Zq<N, B>> for &Zq<N, B>

where B: ArithmeticBackend<N>,

type Output = Zq<N, B>

The resulting type after applying the + operator.

fn add(self, rhs: Zq<N, B>) -> Self::Output

Performs the + operation.

impl<const N: usize, B> Add for Zq<N, B>

where B: ArithmeticBackend<N>,

type Output = Zq<N, B>

The resulting type after applying the + operator.

fn add(self, rhs: Zq<N, B>) -> Self::Output

Performs the + operation.

impl<const N: usize, B: ArithmeticBackend<N>> Clone for Zq<N, B>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize, B: ArithmeticBackend<N>> Debug for Zq<N, B>

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

Formats the value using the given formatter.

impl<'de, const N: usize, B: ArithmeticBackend<N>> Deserialize<'de> for Zq<N, B>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const N: usize, B: FieldBackend + ArithmeticBackend<N>> Field for Zq<N, B>

fn inverse(&self) -> Self

Compute the inverse of self

impl<const N: usize, B: ArithmeticBackend<N>> From<i32> for Zq<N, B>

fn from(value: i32) -> Self

Converts to this type from the input type.

impl<const N: usize, B: ArithmeticBackend<N>> From<i64> for Zq<N, B>

fn from(value: i64) -> Self

Returns value over the range [-q/2, q/2].

Remarks

Calling this over Zq where |value| > q /2 may result in incorrect results

Panics

If value is i64::MIN.

impl<const N: usize, B: ArithmeticBackend<N>> From<u32> for Zq<N, B>

fn from(value: u32) -> Self

Converts to this type from the input type.

impl<const N: usize, B: ArithmeticBackend<N>> From<u64> for Zq<N, B>

fn from(value: u64) -> Self

Returns value % q.

impl<const N: usize, B: ArithmeticBackend<N>> Mul<&Zq<N, B>> for &Zq<N, B>

type Output = Zq<N, B>

The resulting type after applying the * operator.

fn mul(self, rhs: &Zq<N, B>) -> Self::Output

Performs the * operation.

impl<const N: usize, B: ArithmeticBackend<N>> Mul<&Zq<N, B>> for Zq<N, B>

type Output = Zq<N, B>

The resulting type after applying the * operator.

fn mul(self, rhs: &Zq<N, B>) -> Self::Output

Performs the * operation.

impl<const N: usize, B: ArithmeticBackend<N>> Mul<Zq<N, B>> for &Zq<N, B>

type Output = Zq<N, B>

The resulting type after applying the * operator.

fn mul(self, rhs: Zq<N, B>) -> Self::Output

Performs the * operation.

impl<const N: usize, B: ArithmeticBackend<N>> Mul for Zq<N, B>

type Output = Zq<N, B>

The resulting type after applying the * operator.

fn mul(self, rhs: Zq<N, B>) -> Self::Output

Performs the * operation.

impl<const N: usize, B: ArithmeticBackend<N>> Neg for &Zq<N, B>

type Output = Zq<N, B>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<const N: usize, B: ArithmeticBackend<N>> Neg for Zq<N, B>

type Output = Zq<N, B>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<const N: usize, B: ArithmeticBackend<N>> One for Zq<N, B>

fn one() -> Self

The multiplicative identity.

impl<const N: usize, B: ArithmeticBackend<N>> Ord for Zq<N, B>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<const N: usize, B: ArithmeticBackend<N>> PartialEq for Zq<N, B>

fn eq(&self, other: &Self) -> 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<const N: usize, B: ArithmeticBackend<N>> PartialOrd for Zq<N, B>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<B: ArithmeticBackend<M>, const M: usize, const N: usize> RingModulus<N> for Zq<M, B>

fn field_modulus() -> Uint<N>

The modulus of the field.

fn field_modulus_div_2() -> Uint<N>

The modulus of the field divided by 2.

impl<const N: usize, B: ArithmeticBackend<N>> Serialize for Zq<N, B>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<const N: usize, B> Sub<&Zq<N, B>> for &Zq<N, B>

where B: ArithmeticBackend<N>,

type Output = Zq<N, B>

The resulting type after applying the - operator.

fn sub(self, rhs: &Zq<N, B>) -> Self::Output

Performs the - operation.

impl<const N: usize, B> Sub<&Zq<N, B>> for Zq<N, B>

where B: ArithmeticBackend<N>,

type Output = Zq<N, B>

The resulting type after applying the - operator.

fn sub(self, rhs: &Zq<N, B>) -> Self::Output

Performs the - operation.

impl<const N: usize, B> Sub<Zq<N, B>> for &Zq<N, B>

where B: ArithmeticBackend<N>,

type Output = Zq<N, B>

The resulting type after applying the - operator.

fn sub(self, rhs: Zq<N, B>) -> Self::Output

Performs the - operation.

impl<const N: usize, B> Sub for Zq<N, B>

where B: ArithmeticBackend<N>,

type Output = Zq<N, B>

The resulting type after applying the - operator.

fn sub(self, rhs: Zq<N, B>) -> Self::Output

Performs the - operation.

impl<const N: usize, B: ArithmeticBackend<N>> TryFrom<Uint<N>> for Zq<N, B>

fn try_from(value: Uint<N>) -> Result<Self, Self::Error>

Fails if value >= C::MODULUS.

type Error = Error

The type returned in the event of a conversion error.

impl<const N: usize, B: ArithmeticBackend<N>> Zero for Zq<N, B>

fn zero() -> Self

The additive identity.

fn vartime_is_zero(&self) -> bool

Whether or not this item is zero.

impl<const N: usize, B: ArithmeticBackend<N>> Copy for Zq<N, B>

impl<const N: usize, B: ArithmeticBackend<N>> Eq for Zq<N, B>

impl<const N: usize, B: ArithmeticBackend<N>> Ring for Zq<N, B>