Struct ndarray_rand::rand_distr::Cauchy

pub struct Cauchy<F> where
    F: Float + FloatConst,
    Standard: Distribution<F>,  { /* fields omitted */ }

The Cauchy distribution Cauchy(median, scale).

This distribution has a density function: f(x) = 1 / (pi * scale * (1 + ((x - median) / scale)^2))

Note that at least for f32, results are not fully portable due to minor differences in the target system’s tan implementation, tanf.

Example

use rand_distr::{Cauchy, Distribution};

let cau = Cauchy::new(2.0, 5.0).unwrap();
let v = cau.sample(&mut rand::thread_rng());
println!("{} is from a Cauchy(2, 5) distribution", v);

Implementations

impl<F> Cauchy<F> where
    F: Float + FloatConst,
    Standard: Distribution<F>, 

pub fn new(median: F, scale: F) -> Result<Cauchy<F>, Error>

Construct a new Cauchy with the given shape parameters median the peak location and scale the scale factor.

Trait Implementations

impl<F> Clone for Cauchy<F> where
    F: Clone + Float + FloatConst,
    Standard: Distribution<F>, 

pub fn clone(&self) -> Cauchy<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F> Copy for Cauchy<F> where
    F: Copy + Float + FloatConst,
    Standard: Distribution<F>, 

impl<F> Debug for Cauchy<F> where
    F: Debug + Float + FloatConst,
    Standard: Distribution<F>, 

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

Formats the value using the given formatter.

impl<F> Distribution<F> for Cauchy<F> where
    F: Float + FloatConst,
    Standard: Distribution<F>, 

pub 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.

pub fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T> where
    R: Rng, 

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