Struct rand::distributions::Pareto

pub struct Pareto { /* private fields */ }

Samples floating-point numbers according to the Pareto distribution

Example

use rand::prelude::*;
use rand::distributions::Pareto;

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

Implementations

impl Pareto

pub fn new(scale: f64, shape: f64) -> Pareto

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 α.

Panics

scale and shape have to be non-zero and positive.

Trait Implementations

impl Clone for Pareto

fn clone(&self) -> Pareto

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Pareto

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

Formats the value using the given formatter.

impl Distribution<f64> for Pareto

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

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

fn sample_iter<'a, R>(&'a self, rng: &'a mut R) -> DistIter<'a, Self, R, T> where
    Self: Sized,
    R: Rng, 

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

impl Copy for Pareto