Struct Cauchy

pub struct Cauchy<N> { /* private fields */ }

The Cauchy distribution Cauchy(median, scale).

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

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<N: Float> Cauchy<N>

where Standard: Distribution<N>,

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

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

Trait Implementations

impl<N: Clone> Clone for Cauchy<N>

fn clone(&self) -> Cauchy<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Debug> Debug for Cauchy<N>

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

Formats the value using the given formatter.

impl<N: Float> Distribution<N> for Cauchy<N>

where Standard: Distribution<N>,

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> N

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

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

where R: Rng, Self: Sized,

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

impl<N: Copy> Copy for Cauchy<N>