qfall-math 0.2.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

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

//! This module contains the type [`Factorization`], which is a factorized
//! (or partly factorized) representation of integers with arbitrary length.

use flint3_sys::fmpz_factor_struct;
use std::fmt;

mod default;
mod from;
mod ownership;
mod refine;
mod to_string;

/// [`Factorization`] represents any integer value as its factorization or
/// partly factorization.
///
/// Attributes:
/// - `factors`: holds [FLINT](https://flintlib.org/)'s [struct](fmpz_factor_struct)
///   for a factorization of an integer value
///
/// # Implicit Typecasting
/// Most of our functions take as input values of type Integer.
/// These capture all types that can be turned into a [`Z`](crate::integer::Z) value.
/// The types are [`Z`](crate::integer::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`](crate::integer::Z) before the desired action is performed.
///
/// # Examples
/// ```
/// use qfall_math::utils::Factorization;
/// use qfall_math::integer::Z;
/// use std::str::FromStr;
/// use core::fmt;
///
/// // instantiations
/// let a = Z::from(1200);
/// let b = Z::from(20);
///
/// let fac_1 = Factorization::from(&a);
/// let mut fac_2 = Factorization::from((&a, &b));
///
/// // refinement
/// fac_2.refine();
///
/// // to_string
/// assert_eq!("[(3, 1), (20, 3)]", &fac_2.to_string());
/// ```
pub struct Factorization {
    factors: fmpz_factor_struct,
}

impl fmt::Debug for Factorization {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "Factorization {{ factors: {}, storage: {{ fmpz_factor_struct: {}}}}}",
            self,
            debug_fmpz_factor_struct(&self.factors)
        )
    }
}

fn debug_fmpz_factor_struct(value: &fmpz_factor_struct) -> String {
    format!(
        "fmpz_factor_struct {{ sign: {}, p: {:#x}, exp: {:#x}, alloc: {}, num: {} }}",
        value.sign,
        value.p.addr(),
        value.exp.addr(),
        value.alloc,
        value.num
    )
}