poulpy_core/layouts/
lwe_ct.rs1use std::fmt;
2
3use poulpy_hal::{
4 layouts::{Data, DataMut, DataRef, FillUniform, ReaderFrom, WriterTo, Zn, ZnToMut, ZnToRef, ZnxInfos},
5 source::Source,
6};
7
8use crate::layouts::{Base2K, BuildError, Degree, TorusPrecision};
9use byteorder::{LittleEndian, ReadBytesExt, WriteBytesExt};
10
11pub trait LWEInfos {
12 fn n(&self) -> Degree;
13 fn k(&self) -> TorusPrecision;
14 fn max_k(&self) -> TorusPrecision {
15 TorusPrecision(self.k().0 * self.size() as u32)
16 }
17 fn base2k(&self) -> Base2K;
18 fn size(&self) -> usize {
19 self.k().0.div_ceil(self.base2k().0) as usize
20 }
21 fn lwe_layout(&self) -> LWECiphertextLayout {
22 LWECiphertextLayout {
23 n: self.n(),
24 k: self.k(),
25 base2k: self.base2k(),
26 }
27 }
28}
29
30#[derive(PartialEq, Eq, Copy, Clone, Debug)]
31pub struct LWECiphertextLayout {
32 pub n: Degree,
33 pub k: TorusPrecision,
34 pub base2k: Base2K,
35}
36
37impl LWEInfos for LWECiphertextLayout {
38 fn base2k(&self) -> Base2K {
39 self.base2k
40 }
41
42 fn k(&self) -> TorusPrecision {
43 self.k
44 }
45
46 fn n(&self) -> Degree {
47 self.n
48 }
49}
50
51#[derive(PartialEq, Eq, Clone)]
52pub struct LWECiphertext<D: Data> {
53 pub(crate) data: Zn<D>,
54 pub(crate) k: TorusPrecision,
55 pub(crate) base2k: Base2K,
56}
57
58impl<D: Data> LWEInfos for LWECiphertext<D> {
59 fn base2k(&self) -> Base2K {
60 self.base2k
61 }
62
63 fn k(&self) -> TorusPrecision {
64 self.k
65 }
66 fn n(&self) -> Degree {
67 Degree(self.data.n() as u32 - 1)
68 }
69
70 fn size(&self) -> usize {
71 self.data.size()
72 }
73}
74
75impl<D: DataRef> LWECiphertext<D> {
76 pub fn data(&self) -> &Zn<D> {
77 &self.data
78 }
79}
80
81impl<D: DataMut> LWECiphertext<D> {
82 pub fn data_mut(&mut self) -> &Zn<D> {
83 &mut self.data
84 }
85}
86
87impl<D: DataRef> fmt::Debug for LWECiphertext<D> {
88 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
89 write!(f, "{self}")
90 }
91}
92
93impl<D: DataRef> fmt::Display for LWECiphertext<D> {
94 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
95 write!(
96 f,
97 "LWECiphertext: base2k={} k={}: {}",
98 self.base2k().0,
99 self.k().0,
100 self.data
101 )
102 }
103}
104
105impl<D: DataMut> FillUniform for LWECiphertext<D>
106where
107 Zn<D>: FillUniform,
108{
109 fn fill_uniform(&mut self, log_bound: usize, source: &mut Source) {
110 self.data.fill_uniform(log_bound, source);
111 }
112}
113
114impl LWECiphertext<Vec<u8>> {
115 pub fn alloc<A>(infos: &A) -> Self
116 where
117 A: LWEInfos,
118 {
119 Self::alloc_with(infos.n(), infos.base2k(), infos.k())
120 }
121
122 pub fn alloc_with(n: Degree, base2k: Base2K, k: TorusPrecision) -> Self {
123 Self {
124 data: Zn::alloc((n + 1).into(), 1, k.0.div_ceil(base2k.0) as usize),
125 k,
126 base2k,
127 }
128 }
129
130 pub fn alloc_bytes<A>(infos: &A) -> usize
131 where
132 A: LWEInfos,
133 {
134 Self::alloc_bytes_with(infos.n(), infos.base2k(), infos.k())
135 }
136
137 pub fn alloc_bytes_with(n: Degree, base2k: Base2K, k: TorusPrecision) -> usize {
138 Zn::alloc_bytes((n + 1).into(), 1, k.0.div_ceil(base2k.0) as usize)
139 }
140}
141
142impl LWECiphertextBuilder<Vec<u8>> {
143 #[inline]
144 pub fn layout<A>(mut self, layout: A) -> Self
145 where
146 A: LWEInfos,
147 {
148 self.data = Some(Zn::alloc((layout.n() + 1).into(), 1, layout.size()));
149 self.base2k = Some(layout.base2k());
150 self.k = Some(layout.k());
151 self
152 }
153}
154
155pub struct LWECiphertextBuilder<D: Data> {
156 data: Option<Zn<D>>,
157 base2k: Option<Base2K>,
158 k: Option<TorusPrecision>,
159}
160
161impl<D: Data> LWECiphertext<D> {
162 #[inline]
163 pub fn builder() -> LWECiphertextBuilder<D> {
164 LWECiphertextBuilder {
165 data: None,
166 base2k: None,
167 k: None,
168 }
169 }
170}
171
172impl<D: Data> LWECiphertextBuilder<D> {
173 #[inline]
174 pub fn data(mut self, data: Zn<D>) -> Self {
175 self.data = Some(data);
176 self
177 }
178 #[inline]
179 pub fn base2k(mut self, base2k: Base2K) -> Self {
180 self.base2k = Some(base2k);
181 self
182 }
183 #[inline]
184 pub fn k(mut self, k: TorusPrecision) -> Self {
185 self.k = Some(k);
186 self
187 }
188
189 pub fn build(self) -> Result<LWECiphertext<D>, BuildError> {
190 let data: Zn<D> = self.data.ok_or(BuildError::MissingData)?;
191 let base2k: Base2K = self.base2k.ok_or(BuildError::MissingBase2K)?;
192 let k: TorusPrecision = self.k.ok_or(BuildError::MissingK)?;
193
194 if base2k.0 == 0 {
195 return Err(BuildError::ZeroBase2K);
196 }
197
198 if k.0 == 0 {
199 return Err(BuildError::ZeroTorusPrecision);
200 }
201
202 if data.n() == 0 {
203 return Err(BuildError::ZeroDegree);
204 }
205
206 if data.cols() == 0 {
207 return Err(BuildError::ZeroCols);
208 }
209
210 if data.size() == 0 {
211 return Err(BuildError::ZeroLimbs);
212 }
213
214 Ok(LWECiphertext { data, base2k, k })
215 }
216}
217
218pub trait LWECiphertextToRef {
219 fn to_ref(&self) -> LWECiphertext<&[u8]>;
220}
221
222impl<D: DataRef> LWECiphertextToRef for LWECiphertext<D> {
223 fn to_ref(&self) -> LWECiphertext<&[u8]> {
224 LWECiphertext::builder()
225 .base2k(self.base2k())
226 .k(self.k())
227 .data(self.data.to_ref())
228 .build()
229 .unwrap()
230 }
231}
232
233pub trait LWECiphertextToMut {
234 #[allow(dead_code)]
235 fn to_mut(&mut self) -> LWECiphertext<&mut [u8]>;
236}
237
238impl<D: DataMut> LWECiphertextToMut for LWECiphertext<D> {
239 fn to_mut(&mut self) -> LWECiphertext<&mut [u8]> {
240 LWECiphertext::builder()
241 .base2k(self.base2k())
242 .k(self.k())
243 .data(self.data.to_mut())
244 .build()
245 .unwrap()
246 }
247}
248
249impl<D: DataMut> ReaderFrom for LWECiphertext<D> {
250 fn read_from<R: std::io::Read>(&mut self, reader: &mut R) -> std::io::Result<()> {
251 self.k = TorusPrecision(reader.read_u32::<LittleEndian>()?);
252 self.base2k = Base2K(reader.read_u32::<LittleEndian>()?);
253 self.data.read_from(reader)
254 }
255}
256
257impl<D: DataRef> WriterTo for LWECiphertext<D> {
258 fn write_to<W: std::io::Write>(&self, writer: &mut W) -> std::io::Result<()> {
259 writer.write_u32::<LittleEndian>(self.k.into())?;
260 writer.write_u32::<LittleEndian>(self.base2k.into())?;
261 self.data.write_to(writer)
262 }
263}