Struct rand_distr::Pareto

pub struct Pareto<F>
where
    F: Float,
    OpenClosed01: Distribution<F>,
{ /* private fields */ }

Samples floating-point numbers according to the Pareto distribution

Example

use rand::prelude::*;
use rand_distr::Pareto;

let val: f64 = thread_rng().sample(Pareto::new(1., 2.).unwrap());
println!("{}", val);

Implementations

impl<F> Pareto<F>

where F: Float, OpenClosed01: Distribution<F>,

pub fn new(scale: F, shape: F) -> Result<Pareto<F>, Error>

Construct a new Pareto distribution with given scale and shape.

In the literature, scale is commonly written as x_m or k and shape is often written as α.

Trait Implementations

impl<F> Clone for Pareto<F>

where F: Float + Clone, OpenClosed01: Distribution<F>,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F> Debug for Pareto<F>

where F: Float + Debug, OpenClosed01: Distribution<F>,

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

Formats the value using the given formatter.

impl<F> Distribution<F> for Pareto<F>

where F: Float, OpenClosed01: Distribution<F>,

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

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.

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

where F: Fn(T) -> S, Self: Sized,

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

impl<F> Copy for Pareto<F>

where F: Float + Copy, OpenClosed01: Distribution<F>,