Struct rand_distr::Cauchy

source · [−]

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

Expand description

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

source

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

source

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

source

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

source

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

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

source

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

Formats the value using the given formatter. Read more

source

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

source

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

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

source

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>ⓘNotable 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;` where
R: Rng,

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

source

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S> where
F: Fn(T) -> S,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F Read more

source

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

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

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

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

source

Struct rand_distr::Cauchy

Example

Implementations

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

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

Trait Implementations

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

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

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

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

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

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

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

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>ⓘNotable 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; where R: Rng,

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S> where F: Fn(T) -> S,

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

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,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

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

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

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

pub fn vzip(self) -> V

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

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

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

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

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>ⓘNotable 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;` where
R: Rng,

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S> where
F: Fn(T) -> S,

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

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,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

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