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
62
63

use rand::{SeedableRng, rngs::StdRng};
use rand_distr::{Distribution, Normal};

/// Generates a random walk using Laplace distribution.
///
/// # Arguments
/// - `scale`: Var(laplace) = $2 * scale^2$
/// - `drift`: `mu` parameter, $start + drift$ is point of peak probability density.
pub fn laplace_random_walk(start: f64, num_steps: usize, scale: 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(0.0, 1.0).unwrap();

	let steps: Vec<f64> = (1..=num_steps)
		.map(|_| {
			let u: f64 = normal.sample(&mut rng);
			let v: f64 = normal.sample(&mut rng);
			drift + scale * (u.abs() - v.abs())
		})
		.collect();

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

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

mod tests {
	#[test]
	fn test_laplace_random_walk() {
		let start = 100.0;
		let num_steps = 1000;
		let scale = 0.1;
		let drift = 0.0;
		let seed = Some(42);

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

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