Struct rand_distr::Zeta

source ·
pub struct Zeta<F>where
    F: Float,
    Standard: Distribution<F>,
    OpenClosed01: Distribution<F>,
{ /* private fields */ }
Expand description

Samples integers according to the zeta distribution.

The zeta distribution is a limit of the Zipf distribution. Sometimes it is called one of the following: discrete Pareto, Riemann-Zeta, Zipf, or Zipf–Estoup distribution.

It has the density function f(k) = k^(-a) / C(a) for k >= 1, where a is the parameter and C(a) is the Riemann zeta function.

Example

use rand::prelude::*;
use rand_distr::Zeta;

let val: f64 = thread_rng().sample(Zeta::new(1.5).unwrap());
println!("{}", val);

Remarks

The zeta distribution has no upper limit. Sampled values may be infinite. In particular, a value of infinity might be returned for the following reasons:

  1. it is the best representation in the type F of the actual sample.
  2. to prevent infinite loops for very small a.

Implementation details

We are using the algorithm from Non-Uniform Random Variate Generation, Section 6.1, page 551.

Implementations

Construct a new Zeta distribution with given a parameter.

Trait Implementations

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Generate a random value of T, using rng as the source of randomness.
Create an iterator that generates random values of T, using rng as the source of randomness. Read more
Create a distribution of values of ‘S’ by mapping the output of Self through the closure F Read more
This method tests for self and other values to be equal, and is used by ==. Read more
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.