qfall-math 0.2.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

// Copyright 2025 Jan 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::Q;
use crate::macros::unsafe_passthrough::{unsafe_getter, unsafe_setter};
use flint3_sys::{fmpq, fmpq_clear};

unsafe_getter!(Q, value, fmpq);

unsafe_setter!(Q, value, fmpq, fmpq_clear);

#[cfg(test)]
mod test_get_fmpq {
    use super::Q;

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

        let mut fmpq_rat = unsafe { rational.get_fmpq() };

        fmpq_rat.num = 2;

        assert_eq!(Q::from(2), rational);
    }
}

#[cfg(test)]
mod test_set_fmpq {
    use super::Q;
    use flint3_sys::fmpq;

    /// Checks availability of the setter for [`Q::value`]
    /// and its ability to modify [`Q`].
    #[test]
    #[allow(unused_mut)]
    fn availability_and_modification() {
        let mut rational = Q::from(1);
        let flint_struct = fmpq { num: 2, den: 1 };

        unsafe { rational.set_fmpq(flint_struct) };

        assert_eq!(Q::from(2), rational);
    }
}