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 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338
//! # Small-world ensemble //! In this specific small-world ensemble each vertex has at least degree 2. //! That means, this small-world ensemble will never exhibit leaves. //! //! I implemented the same model, as I used in my paper //! > Yannick Feld and Alexander K. Hartmann, //! > "Large-deviations of the basin stability of power grids" //! > *Chaos* **29**:113113 (2019), DOI: [10.1063/1.5121415](https://dx.doi.org/10.1063/1.5121415) //! //! where it is described in more detail. //! //! You can find a list of my publications on my [homepage](https://www.yfeld.de/#publications). //! # Citations //! > D. J. Watts and S. H. Strogatz, "Collective dynamics on 'small-world' networks," //! Nature **393**, 440-442 (1998), DOI: [10.1038/30918](https://doi.org/10.1038/30918) use crate::SwGraph; use crate::traits::*; use crate::SwChangeState; const ROOT_EDGES_PER_VERTEX: u32 = 2; /// # Implements small-world graph ensemble /// * for more details look at [documentation](index.html) of module `sw` /// * for topology functions look at [`GenericGraph`](../generic_graph/struct.GenericGraph.html) /// # Sampling /// ## Simple sampling and/or monte carlo steps? /// * look at [Ensemble trait](../traits/trait.Ensemble.html) /// ## Access or manipulate RNG? /// * look at [EnsembleRng trait](../traits/trait.EnsembleRng.html) /// # Minimal example /// ``` /// use net_ensembles::{SwEnsemble, EmptyNode}; /// use net_ensembles::traits::*; // I recommend always using this /// use rand_pcg::Pcg64; //or whatever you want to use as rng /// use rand::SeedableRng; // I use this to seed my rng, but you can use whatever /// /// let rng = Pcg64::seed_from_u64(12); /// /// // now create small-world ensemble with 200 nodes /// // and a rewiring probability of 0.3 for each edge /// let sw_ensemble = SwEnsemble::<EmptyNode, Pcg64>::new(200, 0.3, rng); /// ``` /// # Simple sampling example /// ``` /// use net_ensembles::{SwEnsemble, EmptyNode}; /// use net_ensembles::traits::*; // I recommend always using this /// use rand_pcg::Pcg64; //or whatever you want to use as rng /// use rand::SeedableRng; // I use this to seed my rng, but you can use whatever /// use std::fs::File; /// use std::io::{BufWriter, Write}; /// /// let rng = Pcg64::seed_from_u64(122); /// /// // now create small-world ensemble with 100 nodes /// // and a rewiring probability of 0.3 for each edge /// let mut sw_ensemble = SwEnsemble::<EmptyNode, Pcg64>::new(100, 0.3, rng); /// /// // setup file for writing /// let f = File::create("simple_sample_sw_example.dat") /// .expect("Unable to create file"); /// let mut f = BufWriter::new(f); /// f.write_all(b"#diameter bi_connect_max average_degree\n") /// .unwrap(); /// /// // simple sample for 10 steps /// sw_ensemble.simple_sample(10, /// |ensemble| /// { /// let diameter = ensemble.graph() /// .diameter() /// .unwrap(); /// /// let bi_connect_max = ensemble.graph() /// .clone() /// .vertex_biconnected_components(false)[0]; /// /// let average_degree = ensemble.graph() /// .average_degree(); /// /// write!(f, "{} {} {}\n", diameter, bi_connect_max, average_degree) /// .unwrap(); /// } /// ); /// /// // or just collect this into a vector to print or do whatever /// let vec = sw_ensemble.simple_sample_vec(10, /// |ensemble| /// { /// let diameter = ensemble.graph() /// .diameter() /// .unwrap(); /// /// let transitivity = ensemble.graph() /// .transitivity(); /// (diameter, transitivity) /// } /// ); /// println!("{:?}", vec); /// ``` #[derive(Debug, Clone)] pub struct SwEnsemble<T: Node, R: rand::Rng> { graph: SwGraph<T>, r_prob: f64, rng: R, } impl <T, R> SwEnsemble<T, R> where T: Node, R: rand::Rng, { /// # Initialize /// * create new SwEnsemble graph with `n` vertices /// * `r_prob` is probability of rewiring for each edge /// * `rng` is consumed and used as random number generator in the following /// * internally uses `SwGraph<T>::new(n)` pub fn new(n: u32, r_prob: f64, rng: R) -> Self { let mut graph = SwGraph::new(n); graph.init_ring_2(); let mut result = SwEnsemble { graph, r_prob, rng, }; result.randomize(); result } /// draw number <= high but not index fn draw_remaining(&mut self, index: u32, high: u32) -> u32 { let num = self.rng.gen_range(0, high); if num < index { num } else { num + 1 } } /// edge `(index0, index1)` has to be rooted at `index0` fn randomize_edge(&mut self, index0: u32, index1: u32) -> SwChangeState { let vertex_count = self.graph.vertex_count(); if self.rng.gen::<f64>() <= self.r_prob { let rewire_index = self. draw_remaining(index0, vertex_count - 1); self.graph.rewire_edge(index0, index1, rewire_index) }else { self.graph.reset_edge(index0, index1) } } /// sanity check performed in debug mode fn debug_error_check(state: SwChangeState) -> bool { match state { SwChangeState::GError(_) => panic!("GError"), SwChangeState::InvalidAdjecency => panic!("InvalidAdjecency"), _ => true } } /// * draws random edge `(i0, i1)` /// * edge rooted at `i0` /// * uniform probability /// * result dependent on order of adjecency lists /// * `mut` because it uses the `rng` pub fn draw_edge(&mut self) -> (u32, u32) { // each vertex has the same number of root nodes // the root nodes have an order -> adjecency lists let rng_num = self.rng.gen_range(0, self.graph.edge_count()); let v_index = rng_num / ROOT_EDGES_PER_VERTEX; let e_index = rng_num % ROOT_EDGES_PER_VERTEX; let mut iter = self.graph .container(v_index as usize) .iter_raw_edges() .filter(|x| x.is_root()); let &to = iter .nth(e_index as usize) .unwrap() .to(); (v_index, to) } /// # Sort adjecency lists /// If you depend on the order of the adjecency lists, you can sort them /// # Performance /// * internally uses [pattern-defeating quicksort](https://github.com/orlp/pdqsort) /// as long as that is the standard /// * sorts an adjecency list with length `d` in worst-case: `O(d log(d))` /// * is called for each adjecency list, i.e., `self.vertex_count()` times pub fn sort_adj(&mut self) { self.graph.sort_adj(); } /// * returns reference to the underlying topology aka, the `SwGraph<T>` /// * use this to call functions regarding the topology pub fn graph(&self) -> &SwGraph<T> { &self.graph } /// * access additional information at pub fn at(&self, index: usize) -> & T { self.graph.at(index) } /// * mutable access of additional information at index pub fn at_mut(&mut self, index: usize) -> &mut T { self.graph.at_mut(index) } /// * returns rewiring probability pub fn r_prob(&self) -> f64 { self.r_prob } /// * set new value for rewiring probability /// ## Note /// * will only set the value, which will be used from now on /// * if you also want to create a new sample, call `randomize` afterwards pub fn set_r_prob(&mut self, r_prob: f64) { self.r_prob = r_prob; } } impl<T, R> EnsembleRng<SwChangeState, SwChangeState, R> for SwEnsemble<T, R> where T: Node, R: rand::Rng { /// # Access RNG /// If, for some reason, you want access to the internal random number generator: Here you go fn rng(&mut self) -> &mut R { &mut self.rng } /// # Swap random number generator /// * returns old internal rng fn swap_rng(&mut self, mut rng: R) -> R { std::mem::swap(&mut self.rng, &mut rng); rng } } impl<T, R> Ensemble<SwChangeState, SwChangeState> for SwEnsemble<T, R> where T: Node, R: rand::Rng { /// # Randomizes the edges according to small-world model /// * this is used by `SwEnsemble::new` to create the initial topology /// * you can use this for sampling the ensemble /// * runs in `O(vertices)` fn randomize(&mut self){ let count = self.graph .vertex_count(); for i in 0..count { let vertex = self.graph .get_mut_unchecked(i as usize); let mut root_iter = vertex .iter_raw_edges() .filter(|edge| edge.is_root()) .map(|edge| edge.to()); debug_assert_eq!(ROOT_EDGES_PER_VERTEX, 2); let first = *root_iter.next().unwrap(); let second = *root_iter.next().unwrap(); debug_assert!(root_iter.next().is_none()); let state = self.randomize_edge(i, first); debug_assert!(Self::debug_error_check(state)); let state = self.randomize_edge(i, second); debug_assert!(Self::debug_error_check(state)); } } /// # Monte Carlo step /// * use this to perform a Monte Carlo step /// * keep in mind, that it is not unlikely for a step to do `Nothing` as it works by /// drawing an edge and then reseting it with `r_prob`, else the edge is rewired /// * result `SwChangeState` can be used to undo the step with `self.undo_step(result)` /// * result should never be `InvalidAdjecency` or `GError` if used on a valid graph fn mc_step(&mut self) -> SwChangeState { let edge = self.draw_edge(); self.randomize_edge(edge.0, edge.1) } /// # Undo a Monte Carlo step /// * *rewires* edge to old state /// * Note: cannot undo `InvalidAdjecency` or `GError`, /// will just return `InvalidAdjecency` or `GError` respectively /// * returns result of *rewire* /// ## Important: /// Restored graph is the same as before the random step **except** the order of nodes /// in the adjacency list might be shuffled! fn undo_step(&mut self, step: SwChangeState) -> SwChangeState { match step { SwChangeState::Rewire(root, old_to, new_to) | SwChangeState::Reset (root, old_to, new_to) => self.graph.rewire_edge(root, new_to, old_to), // swap old to and new to in rewire SwChangeState::Nothing | SwChangeState::BlockedByExistingEdge | SwChangeState::InvalidAdjecency | SwChangeState::GError(_) => step } } /// # Undo a Monte Carlo step /// * *rewires* edge to old state /// * **panics** if you try to undo `InvalidAdjecency` or `GError` /// * **panics** if rewire result (`SwChangeState`) is invalid (i.e. `!result.is_valid()`) /// ## Important: /// Restored graph is the same as before the random step **except** the order of nodes /// in the adjacency list might be shuffled! fn undo_step_quiet(&mut self, step: SwChangeState) -> () { match step { SwChangeState::Rewire(root, old_to, new_to) | SwChangeState::Reset (root, old_to, new_to) => { // swap old to and new to in rewire to undo step let state = self.graph.rewire_edge(root, new_to, old_to); if state.is_valid() { () } else { panic!("undo step - rewire error: {:?}", state); } }, SwChangeState::Nothing | SwChangeState::BlockedByExistingEdge => (), SwChangeState::InvalidAdjecency => panic!("undo_step - {:?} - corrupt step?", step), SwChangeState::GError(error) => panic!(format!("undo_step - GError {} - corrupt step?", error)) } } }