1use crate::ffi::module::{delete_module_info, module_info_t, new_module_info, MODULE};
 2use crate::GALOISGENERATOR;
 3
 4#[derive(Copy, Clone)]
 5#[repr(u8)]
 6pub enum MODULETYPE {
 7    FFT64,
 8    NTT120,
 9}
10
11pub struct Module {
12    pub ptr: *mut MODULE,
13    pub n: usize,
14    pub backend: MODULETYPE,
15}
16
17impl Module {
18    // Instantiates a new module.
19    pub fn new(n: usize, module_type: MODULETYPE) -> Self {
20        unsafe {
21            let module_type_u32: u32;
22            match module_type {
23                MODULETYPE::FFT64 => module_type_u32 = 0,
24                MODULETYPE::NTT120 => module_type_u32 = 1,
25            }
26            let m: *mut module_info_t = new_module_info(n as u64, module_type_u32);
27            if m.is_null() {
28                panic!("Failed to create module.");
29            }
30            Self {
31                ptr: m,
32                n: n,
33                backend: module_type,
34            }
35        }
36    }
37
38    pub fn backend(&self) -> MODULETYPE {
39        self.backend
40    }
41
42    pub fn n(&self) -> usize {
43        self.n
44    }
45
46    pub fn log_n(&self) -> usize {
47        (usize::BITS - (self.n() - 1).leading_zeros()) as _
48    }
49
50    pub fn cyclotomic_order(&self) -> u64 {
51        (self.n() << 1) as _
52    }
53
54    // GALOISGENERATOR^|gen| * sign(gen)
55    pub fn galois_element(&self, gen: i64) -> i64 {
56        if gen == 0 {
57            return 1;
58        }
59
60        let mut gal_el: u64 = 1;
61        let mut gen_1_pow: u64 = GALOISGENERATOR;
62        let mut e: usize = gen.abs() as usize;
63        while e > 0 {
64            if e & 1 == 1 {
65                gal_el = gal_el.wrapping_mul(gen_1_pow);
66            }
67
68            gen_1_pow = gen_1_pow.wrapping_mul(gen_1_pow);
69            e >>= 1;
70        }
71
72        gal_el &= self.cyclotomic_order() - 1;
73
74        (gal_el as i64) * gen.signum()
75    }
76
77    pub fn free(self) {
78        unsafe { delete_module_info(self.ptr) }
79        drop(self);
80    }
81}