concrete-core 0.1.6

Concrete is a fully homomorphic encryption (FHE) library that implements Zama's variant of TFHE.
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155

use crate::math::tensor::{
    AsMutElement, AsMutTensor, AsRefElement, AsRefSlice, AsRefTensor, Tensor,
};
use crate::tensor_traits;

use super::MonomialDegree;

/// A monomial term.
///
/// This type represents a free monomial term of a given degree.
///
/// # Example
///
/// ```
/// use concrete_core::math::polynomial::{Monomial, MonomialDegree};
/// let mono = Monomial::allocate(1u8, MonomialDegree(5));
/// assert_eq!(*mono.get_coefficient(), 1u8);
/// assert_eq!(mono.degree(), MonomialDegree(5));
/// ```
#[derive(PartialEq)]
pub struct Monomial<Cont> {
    tensor: Tensor<Cont>,
    degree: MonomialDegree,
}

tensor_traits!(Monomial);

impl<Cont> AsRefElement for Monomial<Cont>
where
    Monomial<Cont>: AsRefTensor,
{
    type Element = <Monomial<Cont> as AsRefTensor>::Element;
    fn as_element(&self) -> &Self::Element {
        self.as_tensor().first()
    }
}

impl<Cont> AsMutElement for Monomial<Cont>
where
    Monomial<Cont>: AsMutTensor,
{
    type Element = <Monomial<Cont> as AsRefTensor>::Element;
    fn as_mut_element(&mut self) -> &mut <Self as AsMutElement>::Element {
        self.as_mut_tensor().first_mut()
    }
}

impl<Coef> Monomial<Vec<Coef>> {
    /// Allocates a new monomial.
    ///
    /// # Example
    ///
    /// ```
    /// use concrete_core::math::polynomial::{Monomial, MonomialDegree};
    /// let mono = Monomial::allocate(1u8, MonomialDegree(5));
    /// assert_eq!(*mono.get_coefficient(), 1u8);
    /// assert_eq!(mono.degree(), MonomialDegree(5));
    /// ```
    pub fn allocate(value: Coef, degree: MonomialDegree) -> Monomial<Vec<Coef>> {
        Monomial {
            tensor: Tensor::from_container(vec![value]),
            degree,
        }
    }
}

impl<Cont> Monomial<Cont> {
    /// Creates a new monomial from a value container and a degree.
    ///
    /// # Examples
    ///
    /// ```
    /// use concrete_core::math::polynomial::{Monomial, MonomialDegree};
    /// let vector = vec![1u8];
    /// let mono = Monomial::from_container(vector.as_slice(), MonomialDegree(5));
    /// assert_eq!(*mono.get_coefficient(), 1u8);
    /// assert_eq!(mono.degree(), MonomialDegree(5));
    /// ```
    pub fn from_container(cont: Cont, degree: MonomialDegree) -> Monomial<Cont>
    where
        Cont: AsRefSlice,
    {
        debug_assert!(
            cont.as_slice().len() == 1,
            "Tried to create a monomial with a container of size different than one"
        );
        Monomial {
            tensor: Tensor::from_container(cont),
            degree,
        }
    }

    /// Returns a reference to the monomial coefficient.
    ///
    /// # Example
    ///
    /// ```
    /// use concrete_core::math::polynomial::{Monomial, MonomialDegree};
    /// let mono = Monomial::allocate(1u8, MonomialDegree(5));
    /// assert_eq!(*mono.get_coefficient(), 1u8);
    /// ```
    pub fn get_coefficient(&self) -> &<Self as AsRefElement>::Element
    where
        Self: AsRefElement,
    {
        self.as_element()
    }

    /// Sets the monomial coefficient.
    ///
    /// # Example
    ///
    /// ```
    /// use concrete_core::math::polynomial::{Monomial, MonomialDegree};
    /// let mut mono = Monomial::allocate(1u8, MonomialDegree(5));
    /// mono.set_coefficient(5u8);
    /// assert_eq!(*mono.get_coefficient(), 5u8);
    /// ```
    pub fn set_coefficient<Coef>(&mut self, coefficient: Coef)
    where
        Self: AsMutElement<Element = Coef>,
    {
        *(self.as_mut_element()) = coefficient;
    }

    /// Returns a mutable reference to the coefficient.
    ///
    /// # Example
    ///
    /// ```
    /// use concrete_core::math::polynomial::{Monomial, MonomialDegree};
    /// let mut mono = Monomial::allocate(1u8, MonomialDegree(5));
    /// *mono.get_mut_coefficient() += 1u8;
    /// assert_eq!(*mono.get_coefficient(), 2u8);
    /// ```
    pub fn get_mut_coefficient(&mut self) -> &mut <Self as AsMutElement>::Element
    where
        Self: AsMutElement,
    {
        self.as_mut_element()
    }

    /// Returns the degree of the monomial.
    ///
    /// # Example
    ///
    /// ```
    /// use concrete_core::math::polynomial::{Monomial, MonomialDegree};
    /// let mono = Monomial::allocate(1u8, MonomialDegree(5));
    /// assert_eq!(mono.degree(), MonomialDegree(5));
    /// ```
    pub fn degree(&self) -> MonomialDegree {
        self.degree
    }
}