Struct StandardDev

pub struct StandardDev(pub f64);

A distribution parameter that uses the standard deviation as representation.

Example:

use concrete_core::prelude::{DispersionParameter, StandardDev};
let params = StandardDev::from_standard_dev(2_f64.powf(-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(32), 2_f64.powf(32. - 25.));
assert_eq!(params.get_modular_log_standard_dev(32), 32. - 25.);
assert_eq!(
    params.get_modular_variance(32),
    2_f64.powf(32. - 25.).powi(2)
);

Tuple Fields

0: f64

Implementations

impl StandardDev

pub fn from_standard_dev(std: f64) -> StandardDev

pub fn from_modular_standard_dev(std: f64, log2_modulus: u32) -> StandardDev

Trait Implementations

impl Clone for StandardDev

fn clone(&self) -> StandardDev

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StandardDev

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StandardDev

fn deserialize<__D>( __deserializer: __D, ) -> Result<StandardDev, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl DispersionParameter for StandardDev

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(&self, log2_modulus: u32) -> f64

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

fn get_modular_variance(&self, log2_modulus: u32) -> f64

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

fn get_modular_log_standard_dev(&self, log2_modulus: u32) -> f64

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

impl PartialEq for StandardDev

fn eq(&self, other: &StandardDev) -> 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 StandardDev

fn partial_cmp(&self, other: &StandardDev) -> 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 Serialize for StandardDev

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for StandardDev

impl StructuralPartialEq for StandardDev