qfall-math 0.2.0

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
65
66
67
68
69
70
71
72
73
74
75
76
77

// 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::MatZq;
use crate::macros::unsafe_passthrough::{
    unsafe_getter, unsafe_getter_indirect, unsafe_setter, unsafe_setter_indirect,
};
use flint3_sys::{
    fmpz_mat_clear, {fmpz_mod_ctx, fmpz_mod_mat_struct},
};

unsafe_getter!(MatZq, matrix, fmpz_mod_mat_struct);
unsafe_getter_indirect!(MatZq, modulus, get_fmpz_mod_ctx, fmpz_mod_ctx);

unsafe_setter!(MatZq, matrix, fmpz_mod_mat_struct, fmpz_mat_clear);
unsafe_setter_indirect!(MatZq, modulus, set_fmpz_mod_ctx, fmpz_mod_ctx);

#[cfg(test)]
mod test_get_fmpz_mod_mat_struct {
    use super::MatZq;
    use crate::traits::MatrixDimensions;
    use std::str::FromStr;

    /// Checks availability of the getter for [`MatZq::matrix`]
    /// and its ability to be modified.
    #[test]
    #[allow(unused_mut)]
    fn availability_and_modification() {
        let mut mat = MatZq::from_str("[[3]] mod 7").unwrap();

        let mut fmpz_mat = unsafe { mat.get_fmpz_mod_mat_struct() };

        fmpz_mat.c = 5;

        assert_eq!(5, mat.get_num_columns());
    }
}

#[cfg(test)]
mod test_set_fmpz_mod_mat_struct {
    use super::MatZq;
    use crate::integer_mod_q::Modulus;
    use flint3_sys::fmpz_mod_mat_init;
    use std::{mem::MaybeUninit, str::FromStr};

    /// Checks availability of the setter for [`MatZq::matrix`]
    /// and its ability to modify [`MatZq`].
    #[test]
    fn availability_and_modification() {
        let mut mat = MatZq::from_str("[[3]] mod 7").unwrap();
        let mut flint_struct = MaybeUninit::uninit();
        let modulus = Modulus::from(7);
        let flint_struct = unsafe {
            fmpz_mod_mat_init(
                flint_struct.as_mut_ptr(),
                1,
                1,
                modulus.get_fmpz_mod_ctx_struct(),
            );
            flint_struct.assume_init()
        };

        unsafe {
            mat.set_fmpz_mod_mat_struct(flint_struct);
        };

        assert_eq!(MatZq::new(1, 1, 7), mat);
    }
}