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
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
use {
    super::OriginalEdge,
    crate::{
        AdjContainer,
        Node,
        GenericGraph,
        watts_strogatz::WSContainer,
        WithGraph,
        HasRng,
        SimpleSample,
        GraphIteratorsMut,
        GraphIterators,
        SerdeStateConform,
        iter::*,
        generic_graph::*,
        traits::*
    },
    rand::{
        Rng,
        distributions::{
            Uniform,
            Distribution
        }
    },
    std::{
        mem::swap,
        num::*,
        convert::AsRef
    }
};

#[cfg(feature = "serde_support")]
use serde::{Serialize, Deserialize};

/// # Specific [GenericGraph] used for watts-strogatz small World graph
pub type WSGraph<T> = GenericGraph<T,WSContainer<T>>;

/// # Implements small-world graph ensemble
/// * Note the implemented traits!
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde_support", derive(Serialize, Deserialize))]
pub struct SmallWorldWS<T, R>
{
    graph: WSGraph<T>,
    rewire_prob: f64,
    rng: R,
    neighbor_distance: NonZeroUsize
}

/// # short for [SmallWorldWS]
/// See [SmallWorldWS] for the implemented traits
pub type WS<T, R> = SmallWorldWS<T, R>;

impl<T, R> WS<T, R>
{
    /// # Returns neigbor distance of the initial ring
    /// A neighbor distance of 1 means, in the original 
    /// ring structure every node is connected to its two nearest neigbors,
    /// a neighbor distance of 2 means, it is connected to its 4 nearest neigbors and so on
    ///
    /// The graph will contain neighbor_distance * system size (i.e. graph.vertex_count())
    /// connections
    pub fn neighbor_distance(&self) -> NonZeroUsize
    {
        self.neighbor_distance
    }

    /// # retunrs rewire probability the ensemble is set to
    /// On average, a fraction of rewire_prob nodes should be rewired
    pub fn rewire_prob(&self) -> f64
    {
        self.rewire_prob
    }
}

/// # Error variants
/// Possible Errors which can be encountered during the initial creation of an instance 
/// of a [WS]
#[derive(Debug, Clone, Copy)]
pub enum WSCreationError{
    /// It is impossible to create the initial ring structure.
    /// You have to either increase the system size of the graph (i.e., the number of nodes)
    /// or reduce the neigbor distance!
    ImpossibleRingRequest,
    /// Something went wrong during the rewireing.
    /// This should not happen. If you encounter this error,
    /// please file a bug report on Github with a minimal example to reproduce the bug. 
    /// Thanks!
    ImpossibleEdgeRequest
}

impl<T, R> WS<T, R>
where T: Node,
    R: Rng
{
    /// # Initialize a [WS] - a small-world ensemble
    /// * `n` is the system size, i.e., how many nodes there should be in the created graphs
    /// * `neighbor_distance` is needed for the initial ring structure. See also [WS::neigbor_distance](`Self::neighbor_distance`)
    /// * `rewire_probability` - each edge will be rewired with a probability of `rewire_probability` - see also [WS::rewire_prob]
    /// * `rng` - random number generator
    pub fn new(
        n: u32,
        neighbor_distance: NonZeroUsize,
        rewire_probability: f64,
        rng: R
    ) -> Result<Self, WSCreationError>
    {
        let minimum_n: usize = 1 + 2 * neighbor_distance.get();
        if (n as usize) < minimum_n {
            return Err(WSCreationError::ImpossibleRingRequest);
        }
        let mut graph = WSGraph::new(n as usize);
        let res = graph.init_ring(neighbor_distance);
        if res.is_err() {
            return Err(WSCreationError::ImpossibleEdgeRequest);
        }
        let mut s = 
            Self
            {
                neighbor_distance,
                rng,
                rewire_prob: rewire_probability,
                graph
            };
        s.randomize();
        Ok(
            s
        )
    }
}

impl<T, R> SmallWorldWS<T, R>
where R: Rng
{
    // Adding a random edge, that does not exist right now and is not "originalEdge"
    fn add_random_edge(&mut self, mut original_edge: OriginalEdge)
    {
        let n = self.graph.vertex_count();
        let die = Uniform::from(0..n as u32);
        let mut first = die.sample(self.rng());
        let mut second = die.sample(self.rng());
        loop{
            // no self loops
            // not the same edge again!
            // no existing edge
            if first == second ||
                (first == original_edge.from && second == original_edge.to)
                || (first == original_edge.to && second == original_edge.from)
                || self.graph.get_mut_unchecked(first as usize)
                    .is_adjacent(second as usize)
            {
                first = die.sample(self.rng());
                second = die.sample(self.rng());
            } else {
                break;
            }

        }

        let mut create_edge = |from: u32, to: u32, mut edge: OriginalEdge| {
            edge.set_origin_false();
            let from_usize = from as usize;
            let to_usize = to as usize;
            let (vertex_from, vertex_to) = self.graph
                .get_2_mut(from_usize, to_usize);
            
            // create edge from --> to
            let (vec_to, vec_original) = vertex_from.edges_mut();
            vec_to.push(to_usize);
            vec_original.push(edge);
            // create edge to --> from
            let (vec_to, vec_original) = vertex_to.edges_mut();
            edge.swap_direction();
            vec_to.push(from_usize);
            vec_original.push(edge)
        };

        if first == original_edge.to || second == original_edge.from {
            original_edge.swap_direction();
            create_edge(second, first, original_edge)
        } else {
            create_edge(first, second, original_edge)
        }
    }
}

impl<T, R> WithGraph<T, WSGraph<T>> for SmallWorldWS<T, R>
{
    fn at(&self, index: usize) -> &T
    {
        self.graph.at(index)
    }

    fn at_mut(&mut self, index: usize) -> &mut T {
        self.graph.at_mut(index)
    }

    fn graph(&self) -> &WSGraph<T> {
        self.as_ref()
    }

    fn sort_adj(&mut self) {
        self.graph.sort_adj()
    }
}

impl<T, R> HasRng<R> for SmallWorldWS<T, R>
where R: Rng
{
    fn swap_rng(&mut self, rng: &mut R) {
        swap(&mut self.rng, rng);
    }

    fn rng(&mut self) -> &mut R {
        &mut self.rng
    }
}

impl<T, R> SimpleSample for SmallWorldWS<T, R>
where R: Rng
{


    fn randomize(&mut self) {
        self.graph.init_ring(self.neighbor_distance).unwrap();
        let n = self.graph.vertex_count();
        let mut rewire_vec = Vec::with_capacity(2 * self.neighbor_distance.get() as usize);

        for i in 0..n{
            let vertex = self.graph
                .get_mut_unchecked(i);
            
            let (i_to, i_original_edges) = vertex.edges_mut();
            let len = i_original_edges.len();
            debug_assert!(len == i_to.len());
            
            for j in (0..len).rev()
            {
                if i_original_edges[j].is_at_origin() 
                    && self.rng.gen::<f64>() <= self.rewire_prob
                {
                    // remove (one direction of) edge to be rewired
                    let edge = i_original_edges.swap_remove(j);
                    rewire_vec.push(edge);
                    i_to.swap_remove(j);
                }
            }

            // remove other direction of all edges that are to be rewired
            rewire_vec.iter()
                .for_each(
                    |edge|
                    {
                        let to = edge.to();
                        let vertex = self.graph.get_mut_unchecked(to);
                        let from = edge.from();
                        vertex.swap_remove_elem(from);
                    }
                );

            rewire_vec.iter()
                .for_each(|&edge| self.add_random_edge(edge));
            
            rewire_vec.clear();
        }
        
    }
}

impl<T, R> AsRef<WSGraph<T>> for SmallWorldWS<T, R>
{
    #[inline]
    fn as_ref(&self) -> &WSGraph<T>{
        &self.graph
    }
}

impl<T, R> GraphIteratorsMut<T, WSGraph<T>, WSContainer<T>> for SmallWorldWS<T, R>
where   T: Node + SerdeStateConform,
        R: rand::Rng
{
    fn contained_iter_neighbors_mut(&mut self, index: usize) ->
        NContainedIterMut<T, WSContainer<T>, IterWrapper>
    {
        self.graph.contained_iter_neighbors_mut(index)
    }

    fn contained_iter_neighbors_mut_with_index(&mut self, index: usize)
        -> INContainedIterMut<'_, T, WSContainer<T>>
    {
        self.graph.contained_iter_neighbors_mut_with_index(index)
    }

    fn contained_iter_mut(&mut self) ->  ContainedIterMut<T, WSContainer<T>> {
        self.graph.contained_iter_mut()
    }
}

impl<T, R> GraphIterators<T, WSGraph<T>, WSContainer<T>> for SmallWorldWS<T, R>
where   T: Node + SerdeStateConform,
        R: rand::Rng
{
    fn contained_iter(&self) -> ContainedIter<'_, T, WSContainer<T>> {
        self.graph().contained_iter()
    }

    fn contained_iter_neighbors(&self, index: usize) -> NContainedIter<'_, T, WSContainer<T>, IterWrapper> {
        self.graph.contained_iter_neighbors(index)   
    }

    fn contained_iter_neighbors_with_index(&self, index: usize) -> NIContainedIter<T, WSContainer<T>> {
        self.graph.contained_iter_neighbors_with_index(index)
    }

    fn container_iter(&self) -> core::slice::Iter<'_, WSContainer<T>> {
        self.graph.container_iter()
    }

    fn container_iter_neighbors(&self, index: usize) -> NContainerIter<'_, T, WSContainer<T>, IterWrapper> {
        self.graph.container_iter_neighbors(index)
    }

    fn dfs(&self, index: usize) -> Dfs<'_, T, WSContainer<T>> {
        self.graph.dfs(index)
    }

    fn dfs_with_index(&self, index: usize) -> DfsWithIndex<'_, T, WSContainer<T>> {
        self.graph.dfs_with_index(index)
    }

    fn bfs_index_depth(&self, index: usize) -> Bfs<'_, T, WSContainer<T>> {
        self.graph.bfs_index_depth(index)   
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use rand_pcg::Pcg64;
    use rand::SeedableRng;
    use crate::Dot;
    use crate::EmptyNode;
    use crate::WithGraph;
    use crate::dot_constants::*;
    use std::fs::File;
    use std::io::BufWriter;

    #[test]
    fn creation()
    {
        let sys_size = 300;
        let mut rng_rng = Pcg64::seed_from_u64(925859072932);

        for n in 1..10 {
            let rng = Pcg64::from_rng(&mut rng_rng)
                .unwrap();
            let mut ensemble = WS::<EmptyNode, _>::new(
                sys_size,
                NonZeroUsize::new(n).unwrap(),
                0.1,
                rng
            ).unwrap();
            assert_eq!(
                ensemble.graph().average_degree(),
                (2 * n) as f32
            );
            for _ in 0..20 {
                ensemble.randomize();
                assert_eq!(
                    ensemble.graph().average_degree(),
                    (2 * n) as f32
                );
                for i in 0..sys_size {
                    let v = ensemble.graph.get_mut_unchecked(i as usize);
                    let (to, origin) = v.edges_mut();
                    assert_eq!(to.len(), origin.len());
                    to.iter()
                        .zip(origin.iter())
                        .for_each(
                            |(&to, edge)|
                            {
                                if edge.is_at_origin(){
                                    assert_eq!(
                                        edge.from,
                                        i
                                    );
                                    assert_eq!(
                                        edge.to,
                                        to as u32
                                    );
                                }else {
                                    println!("{:?}",edge);
                                    println!("i: {}, to: {}", i, to);
                                    assert!(
                                        edge.from != i || 
                                            edge.to != to as u32
                                    );
                                }
                            }
                        )
                }
            }
        }
    }

    #[test]
    fn plot()
    {
        let sys_size = 10;
        let n = 2;
        let rng = Pcg64::seed_from_u64(72389458937632);
        let mut ensemble = WS::<EmptyNode, _>::new(
            sys_size,
            NonZeroUsize::new(n).unwrap(),
            0.1,
            rng
        ).unwrap();

        let file = File::create("ws10.dot")
            .unwrap();

        for _ in 0..10 {
            ensemble.randomize();
        }
        
        let writer = BufWriter::new(file);

        ensemble.graph().dot_with_indices(
            writer,
            dot_options!(NO_OVERLAP, MARGIN_0)
        ).unwrap();

        assert!(ensemble.graph().is_connected().unwrap())
    }
}

impl<T, R> Contained<T> for SmallWorldWS<T, R>
where T: Node
{
    fn get_contained(&self, index: usize) -> Option<&T> {
        self.graph.get_contained(index)
    }

    fn get_contained_mut(&mut self, index: usize) -> Option<&mut T> {
        self.graph.get_contained_mut(index)
    }

    unsafe fn get_contained_unchecked(&self, index: usize) -> &T {
        self.graph.get_contained_unchecked(index)
    }

    unsafe fn get_contained_unchecked_mut(&mut self, index: usize) -> &mut T {
        self.graph.get_contained_unchecked_mut(index)
    }
}