v_utils 2.15.41

My utils crate
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

use rand::{SeedableRng, rngs::StdRng};
//Q: do I actually need rand_distr, or would rand::distr be enough?
use rand_distr::{Distribution, Normal};

/// Generates a random walk using Normal distribution.
///
/// # Arguments
/// - `std_dev`: Standard deviation of the normal distribution
/// - `drift`: Mean of the normal distribution
pub fn normal_random_walk(start: f64, num_steps: usize, std_dev: f64, drift: f64, seed: Option<u64>) -> Vec<f64> {
	let mut rng = match seed {
		Some(s) => StdRng::seed_from_u64(s),
		None => StdRng::from_rng(&mut rand::rng()),
	};

	let normal = Normal::new(drift, std_dev).unwrap();

	let steps: Vec<f64> = (1..num_steps).map(|_| normal.sample(&mut rng)).collect();

	let walk: Vec<f64> = steps
		.iter()
		.scan(start, |state, &x| {
			*state += x;
			Some(*state)
		})
		.collect();

	std::iter::once(start).chain(walk).collect()
}

#[cfg(test)]
mod tests {
	use super::*;

	#[test]
	fn test_normal_random_walk() {
		let start = 0.0;
		let num_steps = 1000;
		let std_dev = 0.1;
		let drift = 0.0;
		let seed = Some(42);

		let walk = normal_random_walk(start, num_steps, std_dev, drift, seed);
		let plot = crate::internal_utils::simplified_snapshots::SnapshotP::build(&walk).draw();

		insta::assert_snapshot!(plot, @r###"
                                                                       ▄                 ▂▄ 1.52
                                                                   ▂ ▆ █▁              ▄ ███     
                                                            ▁ ▃    █▃█▅██           ▂▄▄█▇███     
                                                            █▅█  █▇███████▅      ▄▂█████████     
                              ▇ ▄                        ▇█▆███ ▃███████████▁    ███████████     
  ▁          ▁▆              ▅█ █                       ▅██████▂█████████████▄▆▄ ███████████     
  █▆        ▁██          ▃█▅▇██▂█▂▂     ▂            ▇▆▇████████████████████████▂███████████     
  ███▄▁▅   ▇███▅      ▂▂███████████▆▂▂ ▅█▃        ▅▄▂███████████████████████████████████████     
  ██████ ▆▁█████▅ ▆ ▇▁████████████████▄███      ▂▅██████████████████████████████████████████     
  ███████████████▆█▃██████████████████████▇  ▃▆ ████████████████████████████████████████████     
  █████████████████████████████████████████▇ ██▆████████████████████████████████████████████     
  ██████████████████████████████████████████▄███████████████████████████████████████████████-1.54
  "###);
	}
}