poulpy-cpu-avx 0.6.0

A crate providing concrete AVX accelerated CPU implementations of poulpy-hal through its open extension points
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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

//! AVX2-accelerated NTT120 CPU backend for the Poulpy lattice cryptography library.
//!
//! This module provides [`NTT120Avx`], an AVX2-accelerated backend implementation for
//! [`poulpy_hal`] that uses Q120 NTT arithmetic (CRT over four ~30-bit primes). It
//! mirrors the structure of the scalar [`poulpy_cpu_ref::NTT120Ref`] backend, with
//! AVX2-accelerated kernels substituted where available.
//!
//! # Current acceleration status
//!
//! | Domain | Status |
//! |-|-|
//! | Coefficient-domain (`Znx*`) | AVX2 (reuses `crate::znx_avx`) |
//! | NTT forward/inverse | AVX2 (`ntt` module) |
//! | mat_vec BBC product (SVP/VMP hot path) | AVX2 (`mat_vec_avx` module) |
//! | VecZnxBig add/sub/negate | Scalar (future work) |
//! | VecZnxBig normalization | Scalar (future work) |
//!
//! # Scalar types
//!
//! - `ScalarPrep = Q120bScalar` — NTT-domain coefficients (4 × u64, 32 bytes/coeff).
//! - `ScalarBig  = i128` — CRT-reconstructed large coefficients.

pub(crate) mod arithmetic_avx;
pub(crate) mod convolution;
pub(crate) mod mat_vec_avx;
mod module;
pub(crate) mod ntt;
mod prim;
mod vec_znx_big;
pub(crate) mod vec_znx_big_avx;
pub(crate) mod vec_znx_dft_consume;
pub(crate) mod vmp;
mod znx;

/// AVX2-accelerated NTT120 CPU backend for Poulpy HAL.
///
/// `NTT120Avx` is a zero-sized marker type that selects the AVX2-accelerated NTT120 backend
/// when used as the type parameter `B` in [`poulpy_hal::layouts::Module<B>`](poulpy_hal::layouts::Module)
/// and related HAL types. It implements all open extension point (OEP) traits from
/// `poulpy_hal::oep`.
///
/// # Backend characteristics
///
/// - **ScalarPrep**: `Q120bScalar` — NTT-domain coefficients stored as 4 × u64 CRT residues.
/// - **ScalarBig**: `i128` — large-coefficient ring elements use 128-bit signed integers.
/// - **Prime set**: `Primes30` (four ~30-bit primes, Q ≈ 2^120).
///
/// # CPU feature requirements
///
/// **Runtime check**: [`Module::new()`](poulpy_hal::api::ModuleNew::new) verifies that
/// the CPU supports AVX2. If the feature is missing, the constructor panics.
///
/// # Thread safety
///
/// `NTT120Avx` is `Send + Sync` (derived from being a zero-sized, field-less struct).
#[derive(Debug, Clone, Copy)]
pub struct NTT120Avx;

#[cfg(test)]
mod tests;