qfall_math/integer/mat_poly_over_z/
unsafe_functions.rs

1// Copyright © 2025 Niklas Siemer
2//
3// This file is part of qFALL-math.
4//
5// qFALL-math is free software: you can redistribute it and/or modify it under
6// the terms of the Mozilla Public License Version 2.0 as published by the
7// Mozilla Foundation. See <https://mozilla.org/en-US/MPL/2.0/>.
8
9//! This module contains public functions that enable access to underlying
10//! [FLINT](https://flintlib.org/) structs. Therefore, they require to be unsafe.
11
12use super::MatPolyOverZ;
13use crate::macros::unsafe_passthrough::{unsafe_getter, unsafe_setter};
14use flint_sys::fmpz_poly_mat::{fmpz_poly_mat_clear, fmpz_poly_mat_struct};
15
16unsafe_getter!(MatPolyOverZ, matrix, fmpz_poly_mat_struct);
17unsafe_setter!(
18    MatPolyOverZ,
19    matrix,
20    fmpz_poly_mat_struct,
21    fmpz_poly_mat_clear
22);
23
24#[cfg(test)]
25mod test_get_fmpz_poly_mat_struct {
26    use super::MatPolyOverZ;
27    use crate::{integer::PolyOverZ, traits::MatrixGetEntry};
28    use flint_sys::{fmpz_poly::fmpz_poly_set, fmpz_poly_mat::fmpz_poly_mat_entry};
29    use std::str::FromStr;
30
31    /// Checks availability of the getter for [`MatPolyOverZ::matrix`]
32    /// and its ability to be modified.
33    #[test]
34    #[allow(unused_mut)]
35    fn availability_and_modification() {
36        let mut mat = MatPolyOverZ::from_str("[[1  1]]").unwrap();
37        let mut poly = PolyOverZ::from(2);
38
39        let mut fmpz_poly_mat = unsafe { mat.get_fmpz_poly_mat_struct() };
40
41        unsafe {
42            let entry = fmpz_poly_mat_entry(fmpz_poly_mat, 0, 0);
43            fmpz_poly_set(entry, poly.get_fmpz_poly_struct())
44        };
45
46        assert_eq!(poly, mat.get_entry(0, 0).unwrap());
47    }
48}
49
50#[cfg(test)]
51mod test_set_fmpz_poly_mat_struct {
52    use super::MatPolyOverZ;
53    use crate::{integer::PolyOverZ, traits::MatrixGetEntry};
54    use flint_sys::fmpz_poly_mat::fmpz_poly_mat_init;
55    use std::{mem::MaybeUninit, str::FromStr};
56
57    /// Checks availability of the setter for [`MatPolyOverZ::matrix`]
58    /// and its ability to modify [`MatPolyOverZ`].
59    #[test]
60    #[allow(unused_mut)]
61    fn availability_and_modification() {
62        let mut mat = MatPolyOverZ::from_str("[[1  1]]").unwrap();
63        let mut flint_struct = MaybeUninit::uninit();
64        let flint_struct = unsafe {
65            fmpz_poly_mat_init(flint_struct.as_mut_ptr(), 1, 1);
66            flint_struct.assume_init()
67        };
68        let poly = PolyOverZ::default();
69
70        unsafe { mat.set_fmpz_poly_mat_struct(flint_struct) };
71
72        assert_eq!(poly, mat.get_entry(0, 0).unwrap());
73    }
74}
qfall_math/integer/mat_poly_over_z/unsafe_functions.rs

qfall_math/integer/mat_poly_over_z/
unsafe_functions.rs
