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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
use std::error::Error;
use std::fmt;

use backtrace::Backtrace;
use colored::Colorize;
use itertools::izip;
use serde::{Deserialize, Serialize};

use crate::error::CryptoAPIError;
use crate::Torus;
use concrete_core::math::decomposition::SignedDecomposable;
use concrete_core::{crypto, numeric::Numeric};
use concrete_npe as npe;

use super::{read_from_file, write_to_file};
use crate::plaintext::Plaintext;
use concrete_core::math::decomposition::{DecompositionBaseLog, DecompositionLevelCount};

/// Structure describing one particular Encoding
/// # Attributes
/// * `o` - the offset of the encoding
/// * `delta` - the delta of the encoding
/// * `nb_bit_precision` - the minimum number of bits to represent a plaintext
/// * `nb_bit_padding` - the number of bits set to zero in the MSB
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct Encoder {
    pub o: f64,     // with margin between 1 and 0
    pub delta: f64, // with margin between 1 and 0
    pub nb_bit_precision: usize,
    pub nb_bit_padding: usize,
    pub round: bool,
}

impl Encoder {
    /// Instantiate a new Encoder with the provided interval as [min,max[
    /// This encoder is meant to be use in an approximate context.
    ///
    /// # Arguments
    /// * `min`- the minimum real value of the interval
    /// * `max`- the maximum real value of the interval
    /// * `nb_bit_precision` - number of bits to represent a plaintext
    /// * `nb_bit_padding` - number of bits for left padding with zeros
    /// # Output
    /// * a new instantiation of an Encoder
    /// # Example
    /// ```rust
    /// use concrete::Encoder;
    ///
    /// // parameters
    /// let min: f64 = 0.2;
    /// let max: f64 = 0.8;
    /// let nb_bit_precision = 8;
    /// let nb_bit_padding = 4;
    ///
    /// // instantiation
    /// let encoder = Encoder::new(min, max, nb_bit_precision, nb_bit_padding).unwrap();
    /// ```
    pub fn new(
        min: f64,
        max: f64,
        nb_bit_precision: usize,
        nb_bit_padding: usize,
    ) -> Result<Encoder, CryptoAPIError> {
        if min >= max {
            return Err(MinMaxError!(min, max));
        }
        if nb_bit_precision == 0 {
            return Err(PrecisionError!());
        }

        let margin: f64 = (max - min) / (f64::powi(2., nb_bit_precision as i32) - 1.);

        Ok(Encoder {
            o: min,
            delta: max - min + margin,
            nb_bit_precision,
            nb_bit_padding,
            round: false,
        })
    }

    /// Instantiate a new Encoder with the provided interval as [min,max[
    /// This encoder is meant to be use in an exact computation context.
    /// It will round at encode and at decode.
    ///
    /// # Arguments
    /// * `min`- the minimum real value of the interval
    /// * `max`- the maximum real value of the interval
    /// * `nb_bit_precision` - number of bits to represent a plaintext
    /// * `nb_bit_padding` - number of bits for left padding with zeros
    /// # Output
    /// * a new instantiation of an Encoder
    /// # Example
    /// ```rust
    /// use concrete::Encoder;
    ///
    /// // parameters
    /// let min: f64 = 0.2;
    /// let max: f64 = 0.8;
    /// let nb_bit_precision = 8;
    /// let nb_bit_padding = 4;
    ///
    /// // instantiation
    /// let encoder = Encoder::new(min, max, nb_bit_precision, nb_bit_padding).unwrap();
    /// ```
    pub fn new_rounding_context(
        min: f64,
        max: f64,
        nb_bit_precision: usize,
        nb_bit_padding: usize,
    ) -> Result<Encoder, CryptoAPIError> {
        if min >= max {
            return Err(MinMaxError!(min, max));
        }
        if nb_bit_precision == 0 {
            return Err(PrecisionError!());
        }

        let margin: f64 = (max - min) / (f64::powi(2., nb_bit_precision as i32) - 1.);

        Ok(Encoder {
            o: min,
            delta: max - min + margin,
            nb_bit_precision,
            nb_bit_padding,
            round: true,
        })
    }

    /// After an homomorphic operation, update an encoder using the variance
    /// # Arguments
    /// * `variance` - variance
    /// # Output
    /// * return the number of bits of precision affected by the noise
    /// # Example
    /// ```rust
    /// use concrete::Encoder;
    ///
    /// // parameters
    /// let min: f64 = 0.2;
    /// let max: f64 = 0.8;
    /// let nb_bit_precision = 8;
    /// let nb_bit_padding = 4;
    ///
    /// // instantiation
    /// let mut encoder = Encoder::new(min, max, nb_bit_precision, nb_bit_padding).unwrap();
    /// let variance: f64 = f64::powi(2., -30);
    /// let nb_bit_overlap: usize = encoder.update_precision_from_variance(variance).unwrap();
    /// ```
    pub fn update_precision_from_variance(
        &mut self,
        variance: f64,
    ) -> Result<usize, CryptoAPIError> {
        // check output noise
        let nb_noise_bit: usize = npe::nb_bit_from_variance_99(variance, <Torus as Numeric>::BITS);

        // check if there actually some noise in the ciphertext
        if nb_noise_bit == 0 {
            Err(NoNoiseInCiphertext!(variance))
        } else if nb_noise_bit + self.nb_bit_precision + self.nb_bit_padding
            > <Torus as Numeric>::BITS
        {
            // compute the number of bits which can be overwritten by the noise
            let nb_bit_overlap = nb_noise_bit + self.nb_bit_precision + self.nb_bit_padding
                - <Torus as Numeric>::BITS;

            // if the overlap is at least as big as the precision,
            // there is no more message
            self.nb_bit_precision =
                i32::max(self.nb_bit_precision as i32 - nb_bit_overlap as i32, 0i32) as usize;

            Ok(nb_bit_overlap)
        } else {
            Ok(0)
        }
    }

    /// Instantiate a new Encoder with the provided interval as [center-radius,center+radius[
    /// # Arguments
    /// * `center` - the center value of the interval
    /// * `radius` - the distance between the center and the endpoints of the interval
    /// * `nb_bit_precision` - number of bits to represent a plaintext
    /// * `nb_bit_padding` - number of bits for left padding with zeros
    /// # Output
    /// * a new instantiation of an Encoder
    /// # Example
    /// ```rust
    /// use concrete::Encoder;
    ///
    /// // parameters
    /// let center: f64 = 0.;
    /// let radius: f64 = 5.4;
    /// let nb_bit_precision = 8;
    /// let nb_bit_padding = 4;
    ///
    /// // instantiation
    /// let encoder = Encoder::new_centered(center, radius, nb_bit_precision, nb_bit_padding).unwrap();
    /// ```
    pub fn new_centered(
        center: f64,
        radius: f64,
        nb_bit_precision: usize,
        nb_bit_padding: usize,
    ) -> Result<Encoder, CryptoAPIError> {
        if radius <= 0. {
            return Err(RadiusError!(radius));
        }
        if nb_bit_precision == 0 {
            return Err(PrecisionError!());
        }
        Ok(crate::Encoder::new(
            center - radius,
            center + radius,
            nb_bit_precision,
            nb_bit_padding,
        )?)
    }

    /// Encode one single message according to this Encoder parameters
    /// # Arguments
    /// * `message` - a message as a f64
    /// # Output
    /// * a new instantiation of an Plaintext containing only one encoded value (the one we just computed with this function)
    /// # Example
    /// ```rust
    /// use concrete::Encoder;
    ///
    /// // parameters
    /// let min: f64 = 0.2;
    /// let max: f64 = 0.8;
    /// let nb_bit_precision = 8;
    /// let nb_bit_padding = 4;
    /// let message = 0.6;
    ///
    /// // creation of the encoder
    /// let encoder = Encoder::new(min, max, nb_bit_precision, nb_bit_padding).unwrap();
    ///
    /// // encoding
    /// let m = encoder.encode_single(message).unwrap();
    /// ```
    pub fn encode_single(&self, message: f64) -> Result<Plaintext, CryptoAPIError> {
        if message < self.o || message > self.o + self.delta {
            return Err(MessageOutsideIntervalError!(message, self.o, self.delta));
        }
        Ok(Plaintext {
            encoders: vec![self.clone(); 1],
            plaintexts: vec![self.encode_core(message)?; 1],
            nb_plaintexts: 1,
        })
    }

    /// Decode one single plaintext according to this Encoder parameters
    /// # Arguments
    /// * `ec` - an plaintext
    /// # Output
    /// * the decoded value as a f64
    /// # Example
    /// ```rust
    /// use concrete::Encoder;
    ///
    /// // parameters
    /// let min: f64 = 0.2;
    /// let max: f64 = 0.8;
    /// let nb_bit_precision = 8;
    /// let nb_bit_padding = 4;
    /// let message = 0.6;
    ///
    /// // creation of the encoder
    /// let encoder = Encoder::new(min, max, nb_bit_precision, nb_bit_padding).unwrap();
    ///
    /// // encoding
    /// let m = encoder.encode_single(message).unwrap();
    ///
    /// // decoding
    /// let new_message = encoder.decode_single(m.plaintexts[0]).unwrap();
    /// ```
    pub fn decode_single(&self, ec: Torus) -> Result<f64, CryptoAPIError> {
        self.decode_core(ec)
    }

    /// Instantiate a new empty Encoder (set to zero)
    /// # Output
    /// * a new instantiation of an empty Encoder (set to zero)
    /// # Example
    /// ```rust
    /// use concrete::Encoder;
    /// let encoder = Encoder::zero();
    /// ```
    pub fn zero() -> Encoder {
        Encoder {
            o: 0.,
            delta: 0.,
            nb_bit_precision: 0,
            nb_bit_padding: 0,
            round: false,
        }
    }

    /// Encode several message according to this (one) Encoder parameters
    /// The output Plaintext will have plaintexts all computed with the same Encoder parameters
    /// # Arguments
    /// * `messages`- a list of messages as a f64
    /// # Example
    /// ```rust
    /// use concrete::Encoder;
    /// // parameters
    /// let (min, max): (f64, f64) = (0.2, 0.4);
    /// let (precision, padding): (usize, usize) = (8, 4);
    /// let messages: Vec<f64> = vec![0.3, 0.34];
    /// let encoder = Encoder::new(min, max, precision, padding).unwrap();
    /// let plaintexts = encoder.encode(&messages).unwrap();
    /// ```
    pub fn encode(&self, messages: &[f64]) -> Result<Plaintext, CryptoAPIError> {
        let mut result = Plaintext {
            encoders: vec![self.clone(); messages.len()],
            plaintexts: vec![0_u64; messages.len()],
            nb_plaintexts: messages.len(),
        };
        debug_assert!(
            result.plaintexts.len() == result.encoders.len(),
            "result.plaintexts.len() != result.encoders.len()"
        );
        debug_assert!(
            result.plaintexts.len() == messages.len(),
            "result.plaintexts.len() != messages.len()"
        );
        for (pt, encoder, m) in izip!(
            result.plaintexts.iter_mut(),
            result.encoders.iter_mut(),
            messages.iter()
        ) {
            *pt = self.encode_core(*m)?;
            encoder.copy(self);
        }
        Ok(result)
    }

    /// Computes the smallest real number that this encoding can handle
    pub fn get_granularity(&self) -> f64 {
        self.delta / f64::powi(2., self.nb_bit_precision as i32)
    }

    pub fn get_min(&self) -> f64 {
        self.o
    }

    pub fn get_max(&self) -> f64 {
        self.o + self.delta - self.get_granularity()
    }

    pub fn get_size(&self) -> f64 {
        self.delta - self.get_granularity()
    }

    /// Copy the content of the input encoder inside the self encoder
    /// # Argument
    /// * `encoder`- the encoder to be copied
    /// # Example
    /// ```rust
    /// use concrete::Encoder;
    /// // parameters
    /// let (min, max): (f64, f64) = (0.2, 0.4);
    /// let (precision, padding): (usize, usize) = (8, 4);
    ///
    /// let encoder_1 = Encoder::new(min, max, precision, padding).unwrap();
    /// let mut encoder_2 = Encoder::zero();
    /// encoder_2.copy(&encoder_1);
    /// ```
    pub fn copy(&mut self, encoder: &Encoder) {
        self.o = encoder.o;
        self.delta = encoder.delta;
        self.nb_bit_precision = encoder.nb_bit_precision;
        self.nb_bit_padding = encoder.nb_bit_padding;
    }

    /// Crete a new encoder as if one computes a square function divided by 4
    /// # Argument
    /// * `nb_bit_padding`- number of bits for left padding with zeros
    /// # Example
    /// ```rust
    /// use concrete::Encoder;
    ///
    /// // parameters
    /// let min: f64 = 0.2;
    /// let max: f64 = 0.8;
    /// let nb_bit_precision = 8;
    /// let nb_bit_padding = 4;
    ///
    /// // instantiation
    /// let encoder_in = Encoder::new(min, max, nb_bit_precision, nb_bit_padding).unwrap();
    /// let encoder_out = encoder_in
    ///     .new_square_divided_by_four(nb_bit_padding)
    ///     .unwrap();
    /// ```
    pub fn new_square_divided_by_four(
        &self,
        nb_bit_padding: usize,
    ) -> Result<Encoder, CryptoAPIError> {
        // valid encoder
        if !self.is_valid() {
            return Err(InvalidEncoderError!(self.nb_bit_precision, self.delta));
        }
        if self.nb_bit_padding < 1 {
            return Err(NotEnoughPaddingError!(self.nb_bit_padding, 1));
        }

        if self.o < 0. && self.o + self.delta < 0. {
            // only negative values in the interval
            let new_max = (self.o * self.o) / 4.;
            let old_max = self.o + self.delta - self.get_granularity();
            let new_min = (old_max * old_max) / 4.;
            Ok(Encoder::new(
                new_min,
                new_max,
                self.nb_bit_precision,
                nb_bit_padding,
            )?)
        } else if self.o > 0. {
            // only positive values in the interval
            let new_min = (self.o * self.o) / 4.;
            let old_max = self.o + self.delta - self.get_granularity();
            let new_max = (old_max * old_max) / 4.;
            Ok(Encoder::new(
                new_min,
                new_max,
                self.nb_bit_precision,
                nb_bit_padding,
            )?)
        } else {
            // 0 is in the interval
            let new_min: f64 = 0.;
            let old_max = self.o + self.delta - self.get_granularity();
            let max = old_max.max(-self.o);
            let new_max = max * max / 4.;
            Ok(Encoder::new(
                new_min,
                new_max,
                self.nb_bit_precision,
                nb_bit_padding,
            )?)
        }
    }

    /// Wrap the core_api encode function with the padding
    /// # Argument
    /// * `m` - the message to encode
    /// # Example
    /// ```rust
    /// use concrete::Encoder;
    ///
    /// // parameters
    /// let min: f64 = 0.2;
    /// let max: f64 = 0.8;
    /// let nb_bit_precision = 8;
    /// let nb_bit_padding = 4;
    ///
    /// // message
    /// let m = 0.3;
    /// // instantiation
    /// let encoder = Encoder::new(min, max, nb_bit_precision, nb_bit_padding).unwrap();
    ///
    /// let plaintext = encoder.encode_core(m).unwrap();
    /// ```
    pub fn encode_core(&self, m: f64) -> Result<Torus, CryptoAPIError> {
        if m < self.o || m >= self.o + self.delta {
            return Err(MessageOutsideIntervalError!(m, self.o, self.delta));
        }
        self.encode_outside_interval_operators(m)
    }

    /// Wrap the core_api encode function with the padding and allows to encode a message that is outside of the interval of the encoder
    /// It is used for correction after homomorphic computation
    /// # Argument
    /// * `m` - the message to encode
    /// ```rust
    /// use concrete::Encoder;
    ///
    /// // parameters
    /// let min: f64 = 0.2;
    /// let max: f64 = 0.8;
    /// let nb_bit_precision = 8;
    /// let nb_bit_padding = 4;
    ///
    /// // message
    /// let m = 1.2;
    /// // instantiation
    /// let encoder = Encoder::new(min, max, nb_bit_precision, nb_bit_padding).unwrap();
    ///
    /// let plaintext = encoder.encode_outside_interval_operators(m).unwrap();
    /// ```
    pub fn encode_outside_interval_operators(&self, m: f64) -> Result<Torus, CryptoAPIError> {
        use concrete_core::crypto::encoding::Encoder as CoreEncoder;

        // check if the encoder is valid
        if !self.is_valid() {
            return Err(InvalidEncoderError!(self.nb_bit_precision, self.delta));
        }

        // call core_api module to encode
        let encoder = crypto::encoding::RealEncoder {
            offset: self.o,
            delta: self.delta,
        };
        let mut res: Torus = encoder.encode(crypto::encoding::Cleartext(m)).0;

        // round if in rounding context
        if self.round {
            res = res.round_to_closest_multiple(
                DecompositionBaseLog(self.nb_bit_precision),
                DecompositionLevelCount(1),
            );
        }

        // shift if there is some padding
        if self.nb_bit_padding > 0 {
            res >>= self.nb_bit_padding;
        }

        Ok(res)
    }

    /// Wrap the core_api decode function with the padding and the rounding
    ///
    /// # Argument
    /// * `pt` - the noisy plaintext
    /// ```rust
    /// use concrete::Encoder;
    ///
    /// // parameters
    /// let min: f64 = 0.2;
    /// let max: f64 = 0.8;
    /// let nb_bit_precision = 8;
    /// let nb_bit_padding = 4;
    ///
    /// // message
    /// let m = 0.3;
    /// // instantiation
    /// let encoder = Encoder::new(min, max, nb_bit_precision, nb_bit_padding).unwrap();
    ///
    /// let plaintext = encoder.encode_core(m).unwrap();
    /// let new_message = encoder.decode_core(plaintext).unwrap();
    /// ```
    pub fn decode_core(&self, pt: Torus) -> Result<f64, CryptoAPIError> {
        use concrete_core::crypto::encoding::Encoder as CoreEncoder;

        // check valid encoder
        if !self.is_valid() {
            return Err(InvalidEncoderError!(self.nb_bit_precision, self.delta));
        }

        // round if asked
        let mut tmp: Torus = if self.round {
            pt.round_to_closest_multiple(
                DecompositionBaseLog(self.nb_bit_precision + self.nb_bit_padding),
                DecompositionLevelCount(1),
            )
        } else {
            pt
        };

        // remove padding
        if self.nb_bit_padding > 0 {
            tmp <<= self.nb_bit_padding;
        }

        // round if round is set to false and if in the security margin
        let starting_value_security_margin: Torus = ((1 << (self.nb_bit_precision + 1)) - 1)
            << (<Torus as Numeric>::BITS - self.nb_bit_precision);
        tmp = if tmp > starting_value_security_margin {
            tmp.round_to_closest_multiple(
                DecompositionBaseLog(self.nb_bit_precision),
                DecompositionLevelCount(1),
            )
        } else {
            tmp
        };

        let encoder = crypto::encoding::RealEncoder {
            offset: self.o,
            delta: self.delta,
        };

        Ok(encoder.decode(crypto::encoding::Plaintext(tmp)).0)
    }

    /// Check if the Encoder looks valid or not
    /// # Output
    /// return a boolean, true means that it is valid
    pub fn is_valid(&self) -> bool {
        !(self.nb_bit_precision == 0 || self.delta <= 0.)
    }

    pub fn save(&self, path: &str) -> Result<(), Box<dyn Error>> {
        write_to_file(path, self)
    }

    pub fn load(path: &str) -> Result<Encoder, Box<dyn Error>> {
        read_from_file(path)
    }

    /// Modify the encoding to be use after an homomorphic opposite
    /// ```rust
    /// use concrete::Encoder;
    ///
    /// // parameters
    /// let min: f64 = 0.2;
    /// let max: f64 = 0.8;
    /// let nb_bit_precision = 8;
    /// let nb_bit_padding = 4;
    ///
    /// // message
    /// let m = 0.3;
    /// // instantiation
    /// let mut encoder = Encoder::new(min, max, nb_bit_precision, nb_bit_padding).unwrap();
    ///
    /// encoder.opposite_inplace();
    /// ```
    pub fn opposite_inplace(&mut self) -> Result<(), CryptoAPIError> {
        let old_max = self.o + self.delta - self.get_granularity();
        let new_o = -old_max;
        self.o = new_o;
        Ok(())
    }
}

/// Print needed pieces of information about an Encoder
impl fmt::Display for Encoder {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(
            f,
            " Encoder {{
            -> [{},{}[
            -> center = {}
            -> radius = {}
            -> nb bit precision = {}
            -> granularity = {}
            -> nb bit padding = {}
            -> round = {}
        }}
            ",
            self.o,
            self.o + self.delta,
            self.o + self.delta / 2.,
            self.delta / 2.,
            self.nb_bit_precision,
            self.get_granularity(),
            self.nb_bit_padding,
            self.round
        )
    }
}

#[cfg(test)]
mod tests;