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
79
80
81
82
83

// Copyright © 2023 Marcel Luca Schmidt
//
// 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/>.

//! `Z` is a type for integers with arbitrary length.
//! This implementation uses the [FLINT](https://flintlib.org/) library.

use flint_sys::fmpz::fmpz;
use std::fmt;

mod arithmetic;
mod cmp;
mod default;
mod distance;
pub(crate) mod fmpz_helpers;
mod from;
mod gcd;
mod hash;
mod lcm;
mod logic;
mod ownership;
mod properties;
mod sample;
mod serialize;
mod to_string;
mod unsafe_functions;

/// [`Z`] is an arbitrary integer value.
///
/// Attributes:
/// - `value`: holds [FLINT](https://flintlib.org/)'s [struct](fmpz)
///   for an integer value
///
/// # Implicit Typecasting
/// Most of our functions take as input values of type [`Into<Z>`].
/// These capture all types that can be turned into a [`Z`] value.
/// The types are [`Z`],[`Modulus`](crate::integer_mod_q::Modulus), [`i8`],
/// [`i16`],[`i32`],[`i64`],[`u8`],[`u16`],[`u32`],[`u64`] and the
/// references of all of these types. These types are then implicitly casted to a [`Z`]
/// before the desired action is performed.
///
/// # Examples
/// ```
/// use qfall_math::integer::Z;
/// use std::str::FromStr;
///
/// // instantiations
/// let a = Z::from_str("-876543")?;
/// let b = Z::from(i64::MIN);
/// let zero = Z::default();
///
/// // arithmetics
/// let _ = &a * b.clone();
/// let _ = &b - zero;
///
/// // comparison
/// assert_ne!(b, a);
///
/// // to_string incl. (de-)serialization
/// assert_eq!("-876543", &a.to_string());
/// assert_eq!(
///     "{\"value\":\"-876543\"}",
///     serde_json::to_string(&a).unwrap()
/// );
/// # Ok::<(), qfall_math::error::MathError>(())
/// ```
pub struct Z {
    pub(crate) value: fmpz,
}

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