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

// 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/>.

//! [`Modulus`] is a type of a positive integer larger than `1` that is used in
//! order to do modulus operations. The modulus type itself is also used for
//! optimizations.
//! A [`Modulus`] of `1` is not allowed, since operations would always just
//! return `0`. This way, checks later in the code can be avoided.
//!
//! This implementation uses the [FLINT](https://flintlib.org/) library.

use flint_sys::fmpz_mod::fmpz_mod_ctx;
use std::{fmt, rc::Rc};

mod cmp;
mod distance;
mod fmpz_helpers;
mod from;
mod get;
mod ownership;
mod properties;
mod serialize;
mod to_string;
mod unsafe_functions;

/// [`Modulus`] is a type of a positive integer larger than `1` that is used
/// to do modulus operations.
///
/// Attributes:
/// - `modulus`: holds the value of the modulus
///
/// # Examples
/// Create [`Modulus`] from [`str`]:
/// ```
/// use qfall_math::integer_mod_q::Modulus;
/// use std::str::FromStr;
/// use qfall_math::integer::Z;
/// let value = Z::from(10);
///
/// // instantiations
/// let _ = Modulus::from(10);
/// let a = Modulus::from_str("42").unwrap();
/// let b: Modulus = (&value).try_into().unwrap();
///
/// // clone
/// let clone = a.clone();
///
/// // properties
/// let is_prime: bool = a.is_prime();
///
/// // to_string incl. (de-)serialization
/// assert_eq!("42", &a.to_string());
/// assert_eq!(
///     "{\"modulus\":\"42\"}",
///     serde_json::to_string(&a).unwrap()
/// );
///
/// // comparison
/// assert_eq!(a, clone);
/// ```
pub struct Modulus {
    pub(crate) modulus: Rc<fmpz_mod_ctx>,
}

impl fmt::Debug for Modulus {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "Modulus {{ modulus: {}, storage: {{modulus: {:?}}}}}",
            self, self.modulus
        )
    }
}