Struct TruncatedNormal

pub struct TruncatedNormal<T>
where
    StandardNormal: Distribution<T>,
{ /* private fields */ }

The TruncatedNormal distribution is similar to the StandardNormal distribution, differing in that is computes a boundary equal to two standard deviations from the mean. More formally, the boundary is defined as:

\text{boundary} = \mu + 2\sigma

Implementations

impl<T> TruncatedNormal<T>

where T: Copy, StandardNormal: Distribution<T>,

pub const fn new(mean: T, std: T) -> Result<TruncatedNormal<T>, InitError>

create a new TruncatedNormal distribution with the given mean and standard deviation; both of which are type T.

pub const fn mean(&self) -> T

returns a copy of the mean for the distribution

pub const fn std_dev(&self) -> T

returns a copy of the standard deviation for the distribution

pub fn boundary(&self) -> T

where T: Float,

compute the boundary of the truncated normal distribution which is two standard deviations from the mean: $$ \text{boundary} = \mu + 2\sigma $$

pub fn distr(&self) -> Normal<T>

where T: Float,

returns a new Normal distribution instance created from the current mean and standard deviation.

pub fn score(&self, x: T) -> T

where T: Float,

compute the score of the distribution at point x. The score is calculated by subtracing a scaled standard deviation from the mean: $$ \text{score}(x) = \mu - \sigma \cdot x $$

where $\mu$ is the mean and $\sigma$ is the standard deviation.

Trait Implementations

impl<T> Clone for TruncatedNormal<T>

where T: Clone, StandardNormal: Distribution<T>,

fn clone(&self) -> TruncatedNormal<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for TruncatedNormal<T>

where T: Debug, StandardNormal: Distribution<T>,

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

Formats the value using the given formatter.

impl<T> Distribution<T> for TruncatedNormal<T>

where T: Float, StandardNormal: Distribution<T>,

fn sample<R>(&self, rng: &mut R) -> T

where R: RngCore + ?Sized,

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> Iter<Self, R, T>

where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness.

fn map<F, S>(self, func: F) -> Map<Self, F, T, S>

where F: Fn(T) -> S, Self: Sized,

Map sampled values to type S

impl<T> From<Normal<T>> for TruncatedNormal<T>

where T: Float, StandardNormal: Distribution<T>,

fn from(normal: Normal<T>) -> TruncatedNormal<T>

Converts to this type from the input type.

impl<T> Hash for TruncatedNormal<T>

where T: Hash, StandardNormal: Distribution<T>,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> Ord for TruncatedNormal<T>

where T: Ord, StandardNormal: Distribution<T>,

fn cmp(&self, other: &TruncatedNormal<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T> PartialEq for TruncatedNormal<T>

where T: PartialEq, StandardNormal: Distribution<T>,

fn eq(&self, other: &TruncatedNormal<T>) -> bool

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

const 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<T> PartialOrd for TruncatedNormal<T>

where T: PartialOrd, StandardNormal: Distribution<T>,

fn partial_cmp(&self, other: &TruncatedNormal<T>) -> 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<T> Copy for TruncatedNormal<T>

where T: Copy, StandardNormal: Distribution<T>,

impl<T> Eq for TruncatedNormal<T>

where T: Eq, StandardNormal: Distribution<T>,

impl<T> StructuralPartialEq for TruncatedNormal<T>

where StandardNormal: Distribution<T>,