Struct ndarray_rand::rand_distr::Cauchy

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

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);

Methods

impl<N> Cauchy<N> where
    N: Float,
    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> Debug for Cauchy<N> where
    N: Debug, 

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

Formats the value using the given formatter.

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

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

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> Distribution<N> for Cauchy<N> where
    N: Float,
    Standard: Distribution<N>, 

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

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

Important traits for DistIter<D, R, T>

impl<D, R, T> Iterator for DistIter<D, R, T> where
    D: Distribution<T>,
    R: Rng,  type Item = T;

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.