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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

// Copyright © 2025 Niklas Siemer
//
// 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/>.

//! This module contains public functions that enable access to underlying
//! [FLINT](https://flintlib.org/) structs. Therefore, they require to be unsafe.

use super::PolyOverQ;
use crate::macros::unsafe_passthrough::{unsafe_getter, unsafe_setter};
use flint_sys::fmpq_poly::{fmpq_poly_clear, fmpq_poly_struct};

unsafe_getter!(PolyOverQ, poly, fmpq_poly_struct);

unsafe_setter!(PolyOverQ, poly, fmpq_poly_struct, fmpq_poly_clear);

#[cfg(test)]
mod test_get_fmpq_poly_struct {
    use super::PolyOverQ;
    use crate::rational::Q;
    use flint_sys::fmpq_poly::fmpq_poly_set_coeff_fmpq;

    /// Checks availability of the getter for [`PolyOverQ::poly`]
    /// and its ability to be modified.
    #[test]
    #[allow(unused_mut)]
    fn availability_and_modification() {
        let mut poly = PolyOverQ::from(1);
        let mut value = Q::from(2);

        let mut fmpq_poly = unsafe { poly.get_fmpq_poly_struct() };

        unsafe { fmpq_poly_set_coeff_fmpq(fmpq_poly, 0, value.get_fmpq()) };

        assert_eq!(PolyOverQ::from(2), poly);
    }
}

#[cfg(test)]
mod test_set_fmpq_poly_struct {
    use super::PolyOverQ;
    use flint_sys::fmpq_poly::fmpq_poly_init;
    use std::mem::MaybeUninit;

    /// Checks availability of the setter for [`PolyOverQ::poly`]
    /// and its ability to modify [`PolyOverQ`].
    #[test]
    #[allow(unused_mut)]
    fn availability_and_modification() {
        let mut poly = PolyOverQ::from(1);
        let mut flint_struct = MaybeUninit::uninit();
        let flint_struct = unsafe {
            fmpq_poly_init(flint_struct.as_mut_ptr());
            flint_struct.assume_init()
        };

        unsafe { poly.set_fmpq_poly_struct(flint_struct) };

        assert_eq!(PolyOverQ::from(0), poly);
    }
}