poulpy_core/layouts/
glwe_automorphism_key.rs

1use poulpy_hal::{
2    layouts::{Backend, Data, DataMut, DataRef, FillUniform, ReaderFrom, WriterTo},
3    source::Source,
4};
5
6use crate::layouts::{
7    Base2K, Degree, Dnum, Dsize, GGLWE, GGLWEInfos, GGLWELayout, GGLWEToMut, GGLWEToRef, GLWE, GLWEInfos, LWEInfos, Rank,
8    TorusPrecision,
9};
10use byteorder::{LittleEndian, ReadBytesExt, WriteBytesExt};
11
12use std::fmt;
13
14pub trait GLWEAutomorphismKeyHelper<K, BE: Backend> {
15    fn get_automorphism_key(&self, k: i64) -> Option<&K>;
16    fn automorphism_key_infos(&self) -> GGLWELayout;
17}
18
19#[derive(PartialEq, Eq, Copy, Clone, Debug)]
20pub struct GLWEAutomorphismKeyLayout {
21    pub n: Degree,
22    pub base2k: Base2K,
23    pub k: TorusPrecision,
24    pub rank: Rank,
25    pub dnum: Dnum,
26    pub dsize: Dsize,
27}
28
29#[derive(PartialEq, Eq, Clone)]
30pub struct GLWEAutomorphismKey<D: Data> {
31    pub(crate) key: GGLWE<D>,
32    pub(crate) p: i64,
33}
34
35pub trait GetGaloisElement {
36    fn p(&self) -> i64;
37}
38
39pub trait SetGaloisElement {
40    fn set_p(&mut self, p: i64);
41}
42
43impl<D: DataMut> SetGaloisElement for GLWEAutomorphismKey<D> {
44    fn set_p(&mut self, p: i64) {
45        self.p = p
46    }
47}
48
49impl<D: DataRef> GetGaloisElement for GLWEAutomorphismKey<D> {
50    fn p(&self) -> i64 {
51        self.p
52    }
53}
54
55impl<D: Data> GLWEAutomorphismKey<D> {
56    pub fn p(&self) -> i64 {
57        self.p
58    }
59}
60
61impl<D: Data> LWEInfos for GLWEAutomorphismKey<D> {
62    fn n(&self) -> Degree {
63        self.key.n()
64    }
65
66    fn base2k(&self) -> Base2K {
67        self.key.base2k()
68    }
69
70    fn k(&self) -> TorusPrecision {
71        self.key.k()
72    }
73
74    fn size(&self) -> usize {
75        self.key.size()
76    }
77}
78
79impl<D: Data> GLWEInfos for GLWEAutomorphismKey<D> {
80    fn rank(&self) -> Rank {
81        self.rank_out()
82    }
83}
84
85impl<D: Data> GGLWEInfos for GLWEAutomorphismKey<D> {
86    fn rank_in(&self) -> Rank {
87        self.key.rank_in()
88    }
89
90    fn rank_out(&self) -> Rank {
91        self.key.rank_out()
92    }
93
94    fn dsize(&self) -> Dsize {
95        self.key.dsize()
96    }
97
98    fn dnum(&self) -> Dnum {
99        self.key.dnum()
100    }
101}
102
103impl LWEInfos for GLWEAutomorphismKeyLayout {
104    fn base2k(&self) -> Base2K {
105        self.base2k
106    }
107
108    fn k(&self) -> TorusPrecision {
109        self.k
110    }
111
112    fn n(&self) -> Degree {
113        self.n
114    }
115}
116
117impl GLWEInfos for GLWEAutomorphismKeyLayout {
118    fn rank(&self) -> Rank {
119        self.rank
120    }
121}
122
123impl GGLWEInfos for GLWEAutomorphismKeyLayout {
124    fn rank_in(&self) -> Rank {
125        self.rank
126    }
127
128    fn dsize(&self) -> Dsize {
129        self.dsize
130    }
131
132    fn rank_out(&self) -> Rank {
133        self.rank
134    }
135
136    fn dnum(&self) -> Dnum {
137        self.dnum
138    }
139}
140
141impl<D: DataRef> fmt::Debug for GLWEAutomorphismKey<D> {
142    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
143        write!(f, "{self}")
144    }
145}
146
147impl<D: DataMut> FillUniform for GLWEAutomorphismKey<D> {
148    fn fill_uniform(&mut self, log_bound: usize, source: &mut Source) {
149        self.key.fill_uniform(log_bound, source);
150    }
151}
152
153impl<D: DataRef> fmt::Display for GLWEAutomorphismKey<D> {
154    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
155        write!(f, "(AutomorphismKey: p={}) {}", self.p, self.key)
156    }
157}
158
159impl GLWEAutomorphismKey<Vec<u8>> {
160    pub fn alloc_from_infos<A>(infos: &A) -> Self
161    where
162        A: GGLWEInfos,
163    {
164        Self::alloc(
165            infos.n(),
166            infos.base2k(),
167            infos.k(),
168            infos.rank(),
169            infos.dnum(),
170            infos.dsize(),
171        )
172    }
173
174    pub fn alloc(n: Degree, base2k: Base2K, k: TorusPrecision, rank: Rank, dnum: Dnum, dsize: Dsize) -> Self {
175        GLWEAutomorphismKey {
176            key: GGLWE::alloc(n, base2k, k, rank, rank, dnum, dsize),
177            p: 0,
178        }
179    }
180
181    pub fn bytes_of_from_infos<A>(infos: &A) -> usize
182    where
183        A: GGLWEInfos,
184    {
185        assert_eq!(
186            infos.rank_in(),
187            infos.rank_out(),
188            "rank_in != rank_out is not supported for AutomorphismKey"
189        );
190        Self::bytes_of(
191            infos.n(),
192            infos.base2k(),
193            infos.k(),
194            infos.rank(),
195            infos.dnum(),
196            infos.dsize(),
197        )
198    }
199
200    pub fn bytes_of(n: Degree, base2k: Base2K, k: TorusPrecision, rank: Rank, dnum: Dnum, dsize: Dsize) -> usize {
201        GGLWE::bytes_of(n, base2k, k, rank, rank, dnum, dsize)
202    }
203}
204
205impl<D: DataMut> GGLWEToMut for GLWEAutomorphismKey<D> {
206    fn to_mut(&mut self) -> GGLWE<&mut [u8]> {
207        self.key.to_mut()
208    }
209}
210
211impl<D: DataRef> GGLWEToRef for GLWEAutomorphismKey<D> {
212    fn to_ref(&self) -> GGLWE<&[u8]> {
213        self.key.to_ref()
214    }
215}
216
217impl<D: DataRef> GLWEAutomorphismKey<D> {
218    pub fn at(&self, row: usize, col: usize) -> GLWE<&[u8]> {
219        self.key.at(row, col)
220    }
221}
222
223impl<D: DataMut> GLWEAutomorphismKey<D> {
224    pub fn at_mut(&mut self, row: usize, col: usize) -> GLWE<&mut [u8]> {
225        self.key.at_mut(row, col)
226    }
227}
228
229impl<D: DataMut> ReaderFrom for GLWEAutomorphismKey<D> {
230    fn read_from<R: std::io::Read>(&mut self, reader: &mut R) -> std::io::Result<()> {
231        self.p = reader.read_u64::<LittleEndian>()? as i64;
232        self.key.read_from(reader)
233    }
234}
235
236impl<D: DataRef> WriterTo for GLWEAutomorphismKey<D> {
237    fn write_to<W: std::io::Write>(&self, writer: &mut W) -> std::io::Result<()> {
238        writer.write_u64::<LittleEndian>(self.p as u64)?;
239        self.key.write_to(writer)
240    }
241}