Struct rv::dist::Pareto

pub struct Pareto { /* fields omitted */ }

Pareto distribution Pareto(x_m, α) over x in (x_m, ∞).

NOTE: The Pareto distribution is parameterized in terms of shape, α, and scale, x_m.

               α x_m^α
f(x|α, x_m) = ---------
              x^(α + 1)

Implementations

impl Pareto

pub fn new(shape: f64, scale: f64) -> Result<Self, ParetoError>

Create a new Pareto distribution with shape (α) and scale (x_m).

pub fn new_unchecked(shape: f64, scale: f64) -> Self

Creates a new Pareto without checking whether the parameters are valid.

pub fn shape(&self) -> f64

Get shape parameter

Example

let pareto = Pareto::new(1.0, 2.0).unwrap();
assert_eq!(pareto.shape(), 1.0);

pub fn set_shape(&mut self, shape: f64) -> Result<(), ParetoError>

Set the shape parameter

Example

use rv::dist::Pareto;
let mut pareto = Pareto::new(2.0, 1.0).unwrap();
assert_eq!(pareto.shape(), 2.0);

pareto.set_shape(1.1).unwrap();
assert_eq!(pareto.shape(), 1.1);

Will error for invalid values

assert!(pareto.set_shape(1.1).is_ok());
assert!(pareto.set_shape(0.0).is_err());
assert!(pareto.set_shape(-1.0).is_err());
assert!(pareto.set_shape(std::f64::INFINITY).is_err());
assert!(pareto.set_shape(std::f64::NEG_INFINITY).is_err());
assert!(pareto.set_shape(std::f64::NAN).is_err());

pub fn set_shape_unchecked(&mut self, shape: f64)

Set the shape parameter without input validation

pub fn scale(&self) -> f64

Get scale parameter

Example

let pareto = Pareto::new(1.0, 2.0).unwrap();
assert_eq!(pareto.scale(), 2.0);

pub fn set_scale(&mut self, scale: f64) -> Result<(), ParetoError>

Set the scale parameter

Example

use rv::dist::Pareto;
let mut pareto = Pareto::new(2.0, 1.0).unwrap();
assert_eq!(pareto.scale(), 1.0);

pareto.set_scale(1.1).unwrap();
assert_eq!(pareto.scale(), 1.1);

Will error for invalid values

assert!(pareto.set_scale(1.1).is_ok());
assert!(pareto.set_scale(0.0).is_err());
assert!(pareto.set_scale(-1.0).is_err());
assert!(pareto.set_scale(std::f64::INFINITY).is_err());
assert!(pareto.set_scale(std::f64::NEG_INFINITY).is_err());
assert!(pareto.set_scale(std::f64::NAN).is_err());

pub fn set_scale_unchecked(&mut self, scale: f64)

Set the scale parameter without input validation

Trait Implementations

impl Cdf<f32> for Pareto

fn cdf(&self, x: &f32) -> f64

The value of the Cumulative Density Function at x

fn sf(&self, x: &X) -> f64

Survival function, 1 - CDF(x)

impl Cdf<f64> for Pareto

fn cdf(&self, x: &f64) -> f64

The value of the Cumulative Density Function at x

fn sf(&self, x: &X) -> f64

Survival function, 1 - CDF(x)

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 ContinuousDistr<f32> for Pareto

fn pdf(&self, x: &X) -> f64

The value of the Probability Density Function (PDF) at x

fn ln_pdf(&self, x: &X) -> f64

The value of the log Probability Density Function (PDF) at x

impl ContinuousDistr<f64> for Pareto

fn pdf(&self, x: &X) -> f64

The value of the Probability Density Function (PDF) at x

fn ln_pdf(&self, x: &X) -> f64

The value of the log Probability Density Function (PDF) at x

impl Debug for Pareto

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

Formats the value using the given formatter.

impl Display for Pareto

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

Formats the value using the given formatter.

impl Entropy for Pareto

fn entropy(&self) -> f64

The entropy, H(X)

impl<'_> From<&'_ Pareto> for String

fn from(pareto: &Pareto) -> String

Performs the conversion.

impl Kurtosis for Pareto

fn kurtosis(&self) -> Option<f64>

impl Mean<f32> for Pareto

fn mean(&self) -> Option<f32>

Returns None if the mean is undefined

impl Mean<f64> for Pareto

fn mean(&self) -> Option<f64>

Returns None if the mean is undefined

impl Mode<f32> for Pareto

fn mode(&self) -> Option<f32>

Returns None if the mode is undefined or is not a single value

impl Mode<f64> for Pareto

fn mode(&self) -> Option<f64>

Returns None if the mode is undefined or is not a single value

impl PartialEq<Pareto> for Pareto

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Rv<f32> for Pareto

fn ln_f(&self, x: &f32) -> f64

Probability function

fn draw<R: Rng>(&self, rng: &mut R) -> f32

Single draw from the Rv

fn f(&self, x: &X) -> f64

Probability function

fn sample<R: Rng>(&self, n: usize, rng: &mut R) -> Vec<X>

Multiple draws of the Rv

fn sample_stream<'r, R: Rng>(
    &'r self,
    rng: &'r mut R
) -> Box<dyn Iterator<Item = X> + 'r>

Create a never-ending iterator of samples

impl Rv<f64> for Pareto

fn ln_f(&self, x: &f64) -> f64

Probability function

fn draw<R: Rng>(&self, rng: &mut R) -> f64

Single draw from the Rv

fn f(&self, x: &X) -> f64

Probability function

fn sample<R: Rng>(&self, n: usize, rng: &mut R) -> Vec<X>

Multiple draws of the Rv

fn sample_stream<'r, R: Rng>(
    &'r self,
    rng: &'r mut R
) -> Box<dyn Iterator<Item = X> + 'r>

Create a never-ending iterator of samples

impl Skewness for Pareto

fn skewness(&self) -> Option<f64>

impl StructuralPartialEq for Pareto

impl Support<f32> for Pareto

fn supports(&self, x: &f32) -> bool

Returns true if x is in the support of the Rv

impl Support<f64> for Pareto

fn supports(&self, x: &f64) -> bool

Returns true if x is in the support of the Rv

impl Variance<f64> for Pareto

fn variance(&self) -> Option<f64>

Returns None if the variance is undefined