rust-random / rand

A Rust library for random number generation.
https://crates.io/crates/rand
Other
1.67k stars 432 forks source link

CHANGE: Change parameter of Zeta distribution from `a` to `s` #1461

Closed MichaelOwenDyer closed 4 months ago

MichaelOwenDyer commented 5 months ago

The distribution rand_distr::zipf::Zeta uses a as its parameter name, but s is the standard name (on Wikipedia and in the implementation of its sister distribution zipf::Zipf).

Summary

Correcting this would be a breaking change since ZetaError::ATooSmall is pub and potentially depended upon.

Details

Motivation

There is possibly not enough reason to justify this breaking change, as the implementation is not broken by any means. It would be merely a matter of consistency.

Alternatives

dhardy commented 5 months ago

It's a very small breaking change. I think we should go ahead.