Struct rand_distr::Zeta

source ·
pub struct Zeta<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§

source§

impl<F> Zeta<F>

source

pub fn new(a: F) -> Result<Zeta<F>, ZetaError>

Construct a new Zeta distribution with given a parameter.

Trait Implementations§

source§

impl<F> Clone for Zeta<F>

source§

fn clone(&self) -> Zeta<F>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<F> Debug for Zeta<F>

source§

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

Formats the value using the given formatter. Read more
source§

impl<F> Distribution<F> for Zeta<F>

source§

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

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

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. Read more
source§

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 Read more
source§

impl<F> PartialEq for Zeta<F>

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<F> Copy for Zeta<F>

source§

impl<F> StructuralPartialEq for Zeta<F>

Auto Trait Implementations§

§

impl<F> RefUnwindSafe for Zeta<F>
where F: RefUnwindSafe,

§

impl<F> Send for Zeta<F>
where F: Send,

§

impl<F> Sync for Zeta<F>
where F: Sync,

§

impl<F> Unpin for Zeta<F>
where F: Unpin,

§

impl<F> UnwindSafe for Zeta<F>
where F: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V