Struct Polynomial

pub struct Polynomial<M: Modulus> {
    pub coeffs: Vec<u32>,
    /* private fields */
}

A polynomial in a ring R_Q = Z_Q[X]/(X^N + 1)

Fields

coeffs: Vec<u32>

Coefficients of the polynomial, stored in standard representation

Implementations

impl<M: NttModulus> Polynomial<M>

Extension methods for Polynomial

pub fn ntt_inplace(&mut self) -> Result<()>

Convert polynomial to NTT domain

pub fn from_ntt_inplace(&mut self) -> Result<()>

Convert polynomial from NTT domain

pub fn ntt_mul(&self, other: &Self) -> Self

Pointwise multiplication in NTT domain

Both polynomials must already be in NTT domain. For Dilithium: inputs/output in standard domain (post-NTT) For Kyber: inputs/output in Montgomery domain

impl<M: Modulus> Polynomial<M>

pub fn zero() -> Self

Creates a new polynomial with all coefficients set to zero

pub fn from_coeffs(coeffs_slice: &[u32]) -> Result<Self>

Creates a polynomial from a slice of coefficients

pub fn degree() -> usize

Returns the degree N of the polynomial

pub fn modulus_q() -> u32

Returns the modulus Q for coefficient arithmetic

pub fn as_coeffs_slice(&self) -> &[u32]

Returns a slice view of the coefficients

pub fn as_mut_coeffs_slice(&mut self) -> &mut [u32]

Returns a mutable slice view of the coefficients

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

Polynomial addition modulo Q

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

Polynomial subtraction modulo Q

pub fn neg(&self) -> Self

Polynomial negation modulo Q

pub fn scalar_mul(&self, scalar: u32) -> Self

Scalar multiplication

pub fn schoolbook_mul(&self, other: &Self) -> Self

Schoolbook polynomial multiplication with NEGACYCLIC reduction for Dilithium In ring R_q[x]/(x^N + 1), when degree >= N, we have x^N ≡ -1

pub fn reduce_coeffs(&mut self)

In-place coefficient reduction to ensure all coefficients are < Q

Trait Implementations

impl<M: Modulus> Add for &Polynomial<M>

type Output = Polynomial<M>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<M: Modulus> Add for Polynomial<M>

type Output = Polynomial<M>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<M: Clone + Modulus> Clone for Polynomial<M>

fn clone(&self) -> Polynomial<M>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M: Debug + Modulus> Debug for Polynomial<M>

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

Formats the value using the given formatter.

impl<M: Modulus> Neg for &Polynomial<M>

type Output = Polynomial<M>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<M: Modulus> Neg for Polynomial<M>

type Output = Polynomial<M>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<M: PartialEq + Modulus> PartialEq for Polynomial<M>

fn eq(&self, other: &Polynomial<M>) -> 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<M: NttModulus> PolynomialNttExt<M> for Polynomial<M>

fn scalar_mul_montgomery(&self, scalar: u32) -> Polynomial<M>

Fast scalar multiplication using Montgomery reduction

impl<M: Modulus> Sub for &Polynomial<M>

type Output = Polynomial<M>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<M: Modulus> Sub for Polynomial<M>

type Output = Polynomial<M>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<M: Modulus> Zeroize for Polynomial<M>

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl<M: Eq + Modulus> Eq for Polynomial<M>

impl<M: Modulus> StructuralPartialEq for Polynomial<M>