Struct nyx_space::mc::Normal [−][src]
pub struct Normal<F> where
F: Float,
StandardNormal: Distribution<F>, { /* fields omitted */ }Expand description
The normal distribution N(mean, std_dev**2).
This uses the ZIGNOR variant of the Ziggurat method, see StandardNormal
for more details.
Note that StandardNormal is an optimised implementation for mean 0, and
standard deviation 1.
Example
use rand_distr::{Normal, Distribution};
// mean 2, standard deviation 3
let normal = Normal::new(2.0, 3.0).unwrap();
let v = normal.sample(&mut rand::thread_rng());
println!("{} is from a N(2, 9) distribution", v)Implementations
Construct, from mean and standard deviation
Parameters:
- mean (
μ, unrestricted) - standard deviation (
σ, must be finite)
Construct, from mean and coefficient of variation
Parameters:
- mean (
μ, unrestricted) - coefficient of variation (
cv = abs(σ / μ))
Sample from a z-score
This may be useful for generating correlated samples x1 and x2
from two different distributions, as follows.
let mut rng = thread_rng();
let z = StandardNormal.sample(&mut rng);
let x1 = Normal::new(0.0, 1.0).unwrap().from_zscore(z);
let x2 = Normal::new(2.0, -3.0).unwrap().from_zscore(z);Trait Implementations
Generate a random value of T, using rng as the source of randomness.
Create an iterator that generates random values of T, using rng as
the source of randomness. Read more
Auto Trait Implementations
impl<F> RefUnwindSafe for Normal<F> where
F: RefUnwindSafe,
impl<F> UnwindSafe for Normal<F> where
F: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
type Output = T
type Output = T
Should always be Self
The inverse inclusion map: attempts to construct self from the equivalent element of its
superset. Read more
pub fn is_in_subset(&self) -> bool
pub fn is_in_subset(&self) -> bool
Checks if self is actually part of its subset T (and can be converted to it).
pub fn to_subset_unchecked(&self) -> SS
pub fn to_subset_unchecked(&self) -> SS
Use with care! Same as self.to_subset but without any property checks. Always succeeds.
pub fn from_subset(element: &SS) -> SP
pub fn from_subset(element: &SS) -> SP
The inclusion map: converts self to the equivalent element of its superset.