Struct ndarray_rand::rand_distr::Cauchy[][src]

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>, 
[src]

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

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>, 
[src]

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

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

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

Auto Trait Implementations

impl<F> RefUnwindSafe for Cauchy<F> where
    F: RefUnwindSafe

impl<F> Send for Cauchy<F> where
    F: Send

impl<F> Sync for Cauchy<F> where
    F: Sync

impl<F> Unpin for Cauchy<F> where
    F: Unpin

impl<F> UnwindSafe for Cauchy<F> where
    F: UnwindSafe

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,