Struct Pareto

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

The Pareto distribution Pareto(xₘ, α).

The Pareto distribution is a continuous probability distribution with scale parameter xₘ ( or k) and shape parameter α.

Plot

The following plot shows the Pareto distribution with various values of xₘ and α. Note how the shape parameter α corresponds to the height of the jump in density at x = xₘ, and to the rate of decay in the tail.

Example

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

let val: f64 = rand::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<'de, F> Deserialize<'de> for Pareto<F>

where F: Float + Deserialize<'de>, OpenClosed01: Distribution<F>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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> PartialEq for Pareto<F>

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

fn eq(&self, other: &Pareto<F>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<F> Serialize for Pareto<F>

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<F> Copy for Pareto<F>

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

impl<F> StructuralPartialEq for Pareto<F>

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