Struct TruncatedNormal

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

A truncated normal distribution is similar to a normal distribution, however, any generated value over two standard deviations from the mean is discarded and re-generated.

Implementations

impl<F> TruncatedNormal<F>

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

pub fn new(mean: F, std: F) -> Result<Self, NormalError>

Create a new truncated normal distribution with a given mean and standard deviation

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

pub fn mean(&self) -> F

pub fn std_dev(&self) -> F

Trait Implementations

impl<F: Clone> Clone for TruncatedNormal<F>

where StandardNormal: Distribution<F>,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for TruncatedNormal<F>

where StandardNormal: Distribution<F>,

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

Formats the value using the given formatter.

impl<F> Distribution<F> for TruncatedNormal<F>

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

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

where R: Rng + ?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<F> From<Normal<F>> for TruncatedNormal<F>

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

fn from(normal: Normal<F>) -> Self

Converts to this type from the input type.

impl<F: Hash> Hash for TruncatedNormal<F>

where StandardNormal: Distribution<F>,

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

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<F: Ord> Ord for TruncatedNormal<F>

where StandardNormal: Distribution<F>,

fn cmp(&self, other: &TruncatedNormal<F>) -> 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<F: PartialEq> PartialEq for TruncatedNormal<F>

where StandardNormal: Distribution<F>,

fn eq(&self, other: &TruncatedNormal<F>) -> 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<F: PartialOrd> PartialOrd for TruncatedNormal<F>

where StandardNormal: Distribution<F>,

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

where StandardNormal: Distribution<F>,

impl<F: Eq> Eq for TruncatedNormal<F>

where StandardNormal: Distribution<F>,

impl<F> StructuralPartialEq for TruncatedNormal<F>

where StandardNormal: Distribution<F>,