Struct Pareto

pub struct Pareto<N> { /* 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<N: Float> Pareto<N>

where OpenClosed01: Distribution<N>,

pub fn new(scale: N, shape: N) -> Result<Pareto<N>, 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<N: Clone> Clone for Pareto<N>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Debug> Debug for Pareto<N>

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

Formats the value using the given formatter.

impl<N: Float> Distribution<N> for Pareto<N>

where OpenClosed01: Distribution<N>,

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

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.

impl<N: Copy> Copy for Pareto<N>