qfall-math 0.1.1

// Copyright © 2023 Marvin Beckmann
//
// 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 implementations of functions
//! important for serialization such as the [`Serialize`] and [`Deserialize`] trait.
//!
//! The explicit functions contain the documentation.

use super::MatZ;
use crate::macros::serialize::{deserialize, serialize};
use core::fmt;
use serde::{
    Deserialize, Serialize,
    de::{Error, MapAccess, Unexpected, Visitor},
    ser::SerializeStruct,
};
use std::str::FromStr;

serialize!("matrix", MatZ);
deserialize!("matrix", Matrix, MatZ);

#[cfg(test)]
mod test_serialize {
    use crate::integer::MatZ;
    use std::str::FromStr;

    /// Tests whether the serialization of a positive [`MatZ`] works.
    #[test]
    fn serialize_output_positive() {
        let mat_poly_str = "[[17, 42],[1, 17]]";
        let mat_poly_z = MatZ::from_str(mat_poly_str).unwrap();
        let cmp_str = format!("{{\"matrix\":\"{mat_poly_str}\"}}");

        assert_eq!(cmp_str, serde_json::to_string(&mat_poly_z).unwrap());
    }

    /// Tests whether the serialization of a negative [`MatZ`] works.
    #[test]
    fn serialize_output_negative() {
        let mat_poly_str = "[[-17, -42, 1],[-13, -5, -42]]";
        let mat_poly_z = MatZ::from_str(mat_poly_str).unwrap();
        let cmp_str = format!("{{\"matrix\":\"{mat_poly_str}\"}}");

        assert_eq!(cmp_str, serde_json::to_string(&mat_poly_z).unwrap());
    }

    /// Tests whether the serialization of a positive large [`MatZ`] works.
    #[test]
    fn serialize_output_positive_large() {
        let mat_poly_str = format!("[[3, -17, {}, 1, 2, -13, 5]]", u64::MAX);
        let mat_poly_z = MatZ::from_str(&mat_poly_str).unwrap();
        let cmp_str = format!("{{\"matrix\":\"{mat_poly_str}\"}}");

        assert_eq!(cmp_str, serde_json::to_string(&mat_poly_z).unwrap());
    }

    /// Tests whether the serialization of a negative large [`MatZ`] works.
    #[test]
    fn serialize_output_negative_large() {
        let mat_poly_str = format!("[[3, -17, -{}, 1, 2, -13, 5]]", u64::MAX);
        let mat_poly_z = MatZ::from_str(&mat_poly_str).unwrap();
        let cmp_str = format!("{{\"matrix\":\"{mat_poly_str}\"}}");

        assert_eq!(cmp_str, serde_json::to_string(&mat_poly_z).unwrap());
    }
}

#[cfg(test)]
mod test_deserialize {
    use crate::integer::MatZ;
    use std::str::FromStr;

    /// Tests whether the deserialization of a positive [`MatZ`] works.
    #[test]
    fn deserialize_positive() {
        let mat_poly_str = "[[17, 42],[1, 17]]";
        let cmp_str = format!("{{\"matrix\":\"{mat_poly_str}\"}}");

        let mat_poly_z = MatZ::from_str(mat_poly_str).unwrap();
        assert_eq!(mat_poly_z, serde_json::from_str::<MatZ>(&cmp_str).unwrap());
    }

    /// Tests whether the deserialization of a negative [`MatZ`] works.
    #[test]
    fn deserialize_negative() {
        let mat_poly_str = "[[-17, -42, 1],[-13, -5, -42]]";
        let cmp_str = format!("{{\"matrix\":\"{mat_poly_str}\"}}");

        let mat_poly_z = MatZ::from_str(mat_poly_str).unwrap();
        assert_eq!(mat_poly_z, serde_json::from_str::<MatZ>(&cmp_str).unwrap());
    }

    /// Tests whether the deserialization of a positive large [`MatZ`] works.
    #[test]
    fn deserialize_positive_large() {
        let mat_poly_str = format!("[[3, -17, {}, 1, 2, -13, 5]]", u64::MAX);
        let cmp_str = format!("{{\"matrix\":\"{mat_poly_str}\"}}");

        let mat_poly_z = MatZ::from_str(&mat_poly_str).unwrap();
        assert_eq!(mat_poly_z, serde_json::from_str::<MatZ>(&cmp_str).unwrap());
    }

    /// Tests whether the deserialization of a negative large [`MatZ`] works.
    #[test]
    fn deserialize_negative_large() {
        let mat_poly_str = format!("[[3, -17, -{}, 1, 2, -13, 5]]", u64::MAX);
        let cmp_str = format!("{{\"matrix\":\"{mat_poly_str}\"}}");

        let mat_poly_z = MatZ::from_str(&mat_poly_str).unwrap();
        assert_eq!(mat_poly_z, serde_json::from_str::<MatZ>(&cmp_str).unwrap());
    }

    /// Tests whether no fields 'matrix' provided yield an error
    #[test]
    fn no_field_matrix() {
        let a: Result<MatZ, serde_json::Error> =
            serde_json::from_str("{{\"tree\":\"{[[2, 17, 42]]}\"}}");
        assert!(a.is_err());

        let b: Result<MatZ, serde_json::Error> = serde_json::from_str("{{}}");
        assert!(b.is_err());
    }

    /// Tests whether too many fields yield an error
    #[test]
    fn too_many_fields() {
        let a: Result<MatZ, serde_json::Error> = serde_json::from_str(
            "{{\"tree\":\"{[[[2  17 42]]}\", \"matrix\":\"{[[2, 17, 42]]}\"}}",
        );
        assert!(a.is_err());

        let b: Result<MatZ, serde_json::Error> =
            serde_json::from_str("{{\"matrix\":\"{[[1  1]]}\", \"matrix\":\"{[[2, 17, 42]]}\"}}");
        assert!(b.is_err());
    }
}