Struct LogStandardDev 

pub struct LogStandardDev(pub f64);

A distribution parameter that uses the base-2 logarithm of the standard deviation as representation.

Example:

use concrete_commons::dispersion::{DispersionParameter, LogStandardDev};
let params = LogStandardDev::from_log_standard_dev(-25.);
assert_eq!(params.get_standard_dev(), 2_f64.powf(-25.));
assert_eq!(params.get_log_standard_dev(), -25.);
assert_eq!(params.get_variance(), 2_f64.powf(-25.).powi(2));
assert_eq!(
    params.get_modular_standard_dev::<u32>(),
    2_f64.powf(32. - 25.)
);
assert_eq!(params.get_modular_log_standard_dev::<u32>(), 32. - 25.);
assert_eq!(
    params.get_modular_variance::<u32>(),
    2_f64.powf(32. - 25.).powi(2)
);

let modular_params = LogStandardDev::from_modular_log_standard_dev::<u32>(22.);
assert_eq!(modular_params.get_standard_dev(), 2_f64.powf(-10.));

Tuple Fields

0: f64

Implementations

impl LogStandardDev

pub fn from_log_standard_dev(log_std: f64) -> LogStandardDev

pub fn from_modular_log_standard_dev<Uint>(log_std: f64) -> LogStandardDev

where Uint: UnsignedInteger,

Trait Implementations

impl Clone for LogStandardDev

fn clone(&self) -> LogStandardDev

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LogStandardDev

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl DispersionParameter for LogStandardDev

fn get_standard_dev(&self) -> f64

Returns the standard deviation of the distribution, i.e. $\sigma = 2^p$.

fn get_variance(&self) -> f64

Returns the variance of the distribution, i.e. $\sigma^2 = 2^{2p}$.

fn get_log_standard_dev(&self) -> f64

Returns base 2 logarithm of the standard deviation of the distribution, i.e. $\log_2(\sigma)=p$

fn get_modular_standard_dev<Uint>(&self) -> f64

where Uint: UnsignedInteger,

For a Uint type representing $\mathbb{Z}/2^q\mathbb{Z}$, we return $2^{q-p}$.

fn get_modular_variance<Uint>(&self) -> f64

where Uint: UnsignedInteger,

For a Uint type representing $\mathbb{Z}/2^q\mathbb{Z}$, we return $2^{2(q-p)}$.

fn get_modular_log_standard_dev<Uint>(&self) -> f64

where Uint: UnsignedInteger,

For a Uint type representing $\mathbb{Z}/2^q\mathbb{Z}$, we return $q-p$.

impl PartialEq for LogStandardDev

fn eq(&self, other: &LogStandardDev) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for LogStandardDev

fn partial_cmp(&self, other: &LogStandardDev) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for LogStandardDev

impl StructuralPartialEq for LogStandardDev