qfall-math 0.1.1

Mathematical foundations for rapid prototyping of lattice-based cryptography
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

// Copyright © 2023 Marcel Luca Schmidt
//
// This file is part of qFALL-math.
//
// qFALL-math is free software: you can redistribute it and/or modify it under
// the terms of the Mozilla Public License Version 2.0 as published by the
// Mozilla Foundation. See <https://mozilla.org/en-US/MPL/2.0/>.

//! Types for residue classes over integers with arbitrary length based on [`Zq`].
//!
//! This module contains the type [`Zq`] for integers with arbitrary length
//! modulus `q` and constructions over it.
//! Each struct provides examples regarding usage.
//! In general you can mix [`Zq`]'s with any type of rust integer, whenever the
//! corresponding method takes as input integers of type [`Into<Z>`],
//! e.g. the standard rust integers.
//! The [`Modulus`] is constructed as an explicit struct and can be shared across several
//! [`Zq`], [`MatZq`] and [`PolyOverZq`] instances with efficient memory usage.

mod mat_ntt_polynomial_ring_zq;
mod mat_polynomial_ring_zq;
mod mat_zq;
mod modulus;
mod modulus_polynomial_ring_zq;
mod ntt_basis_polynomial_ring_zq;
mod ntt_polynomial_ring_zq;
mod poly_over_zq;
mod polynomial_ring_zq;
mod z_q;

pub use mat_ntt_polynomial_ring_zq::MatNTTPolynomialRingZq;
pub use mat_polynomial_ring_zq::MatPolynomialRingZq;
pub use mat_zq::MatZq;
pub use modulus::Modulus;
pub use modulus_polynomial_ring_zq::ModulusPolynomialRingZq;
pub use ntt_basis_polynomial_ring_zq::{ConvolutionType, NTTBasisPolynomialRingZq};
pub use ntt_polynomial_ring_zq::NTTPolynomialRingZq;
pub use poly_over_zq::PolyOverZq;
pub use polynomial_ring_zq::PolynomialRingZq;
pub use z_q::Zq;
pub(crate) use z_q::fmpz_mod_helpers;