mirror/v
1
0
Fork 0
mirror of https://github.com/vlang/v.git synced 2023-08-10 21:13:21 +03:00
Code Issues Projects Releases Wiki Activity

rand: update documentation for normal and normal_pair (#17898)

Browse Source
This commit is contained in:
Subhomoy Haldar 2023-04-06 15:52:09 +01:00 committed by GitHub
parent 7838ef366a
commit a773e44430
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
vlib/rand/rand.v
View File

@ -351,14 +351,16 @@ pub fn (mut rng PRNG) bernoulli(p f64) !bool {
return rng.f64() <= p return rng.f64() <= p
} }
// normal returns a normally distributed pseudorandom f64 in range `[0, 1)`. // normal returns a normally distributed pseudorandom f64 with mean `mu` and standard
// deviation `sigma`. By default, `mu` is 0.0 and `sigma` is 1.0.
// NOTE: Use normal_pair() instead if you're generating a lot of normal variates. // NOTE: Use normal_pair() instead if you're generating a lot of normal variates.
pub fn (mut rng PRNG) normal(conf config.NormalConfigStruct) !f64 { pub fn (mut rng PRNG) normal(conf config.NormalConfigStruct) !f64 {
x, _ := rng.normal_pair(conf)! x, _ := rng.normal_pair(conf)!
return x return x
} }
// normal_pair returns a pair of normally distributed pseudorandom f64 in range `[0, 1)`. // normal_pair returns a pair of normally distributed pseudorandom f64 with mean `mu` and standard
// deviation `sigma`. By default, `mu` is 0.0 and `sigma` is 1.0.
pub fn (mut rng PRNG) normal_pair(conf config.NormalConfigStruct) !(f64, f64) { pub fn (mut rng PRNG) normal_pair(conf config.NormalConfigStruct) !(f64, f64) {
if conf.sigma <= 0 { if conf.sigma <= 0 {
return error('Standard deviation must be positive') return error('Standard deviation must be positive')
@ -714,13 +716,15 @@ pub fn bernoulli(p f64) !bool {
return default_rng.bernoulli(p) return default_rng.bernoulli(p)
} }
// normal returns a normally distributed pseudorandom f64 in range `[0, 1)`. // normal returns a normally distributed pseudorandom f64 with mean `mu` and standard
// deviation `sigma`. By default, `mu` is 0.0 and `sigma` is 1.0.
// NOTE: Use normal_pair() instead if you're generating a lot of normal variates. // NOTE: Use normal_pair() instead if you're generating a lot of normal variates.
pub fn normal(config_ config.NormalConfigStruct) !f64 { pub fn normal(config_ config.NormalConfigStruct) !f64 {
return default_rng.normal(config_) return default_rng.normal(config_)
} }
// normal_pair returns a pair of normally distributed pseudorandom f64 in range `[0, 1)`. // normal_pair returns a pair of normally distributed pseudorandom f64 with mean `mu` and standard
// deviation `sigma`. By default, `mu` is 0.0 and `sigma` is 1.0.
pub fn normal_pair(config_ config.NormalConfigStruct) !(f64, f64) { pub fn normal_pair(config_ config.NormalConfigStruct) !(f64, f64) {
return default_rng.normal_pair(config_) return default_rng.normal_pair(config_)
} }