idtree 0.2.0

ID-Tree dynamic connectivity data structure
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
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
// This is primarily an ad-hoc profiling build.
//
#![allow(dead_code)]
use std::env;
use std::fmt;
use std::fs::File;
use std::io::{BufRead, BufReader};
use std::path::PathBuf;
use std::time::Instant;

use hdrhistogram::Histogram;
use idtree::IDTree;
use idtree::bridge::ffi;
use nohash_hasher::{IntMap, IntSet};
use rand::SeedableRng;
use rand::prelude::SliceRandom;
use rand::prelude::*;
use rand::rngs::StdRng;
use statrs::statistics::Statistics;

#[derive(Clone, Copy, PartialEq, Eq, Hash)]
enum TaskVariant {
    CPPDNDTree,
    IDTree,
}

impl TaskVariant {
    fn name(&self) -> &'static str {
        match self {
            TaskVariant::CPPDNDTree => "CPPDNDTree",
            TaskVariant::IDTree => "IDTree",
        }
    }
}

#[derive(Clone, Copy)]
struct Task {
    variant: TaskVariant,
}

impl fmt::Display for Task {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.variant.name())
    }
}

impl Task {
    fn new(variant: TaskVariant) -> Task {
        Task { variant }
    }
}

// MARK: Reporting

#[derive(Debug, Clone, Copy)]
enum OpType {
    Insertion,
    QueryCold,
    QueryWarm,
    Deletion,
}

impl fmt::Display for OpType {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            OpType::Insertion => write!(f, "INSERTION"),
            OpType::QueryCold => write!(f, "QUERY (COLD)"),
            OpType::QueryWarm => write!(f, "QUERY (WARM)"),
            OpType::Deletion => write!(f, "DELETION"),
        }
    }
}

fn report(task: Task, sample_data: Vec<Vec<Vec<(i32, usize)>>>) {
    println!("\nTASK: {}", task);
    println!(
        "{:<24} | {:<8} | {:<10} | {:<10} | {:<8} | {:<8} | {:<8}",
        "Result Type", "Count", "Mean (ns)", "StdDev", "P50", "P99", "Max"
    );

    let op_types = [
        OpType::Insertion,
        OpType::QueryCold,
        OpType::QueryWarm,
        OpType::Deletion,
    ];

    for (op_idx, op_type) in op_types.iter().enumerate() {
        let mut raw_nanos_map: IntMap<i32, Vec<usize>> = IntMap::default();

        for sample in &sample_data {
            if let Some(trace) = sample.get(op_idx) {
                for &(code, nanos) in trace {
                    raw_nanos_map.entry(code).or_default().push(nanos);
                }
            }
        }

        if raw_nanos_map.is_empty() {
            continue;
        }

        println!("{}", "-".repeat(90));
        println!("--- {} ---", op_type);

        let mut sorted_codes: Vec<_> = raw_nanos_map.keys().collect();
        sorted_codes.sort();

        for &code in sorted_codes {
            let nanos_vec = &raw_nanos_map[&code];

            let mut hist = Histogram::<u64>::new_with_bounds(1, 100_000_000, 3).unwrap();
            let mut f64_samples: Vec<f64> = Vec::with_capacity(nanos_vec.len());

            for &n in nanos_vec {
                let _ = hist.record(n as u64);
                f64_samples.push(n as f64);
            }

            let mean = f64_samples.as_slice().mean();
            let std_dev = f64_samples.as_slice().std_dev();

            // Map integer codes to descriptive labels based on OpType
            let label = match op_type {
                OpType::Insertion => match code {
                    0 => "Non-Tree Edge",
                    1 => "Tree Edge",
                    2 => "Non-Tree Reroot",
                    3 => "Tree Reroot",
                    _ => "Invalid/Other",
                },
                OpType::Deletion => match code {
                    0 => "Non-Tree Edge",
                    1 => "Tree Edge (Split)",
                    2 => "Tree Edge (Replaced)",
                    _ => "Invalid/Other",
                },
                OpType::QueryCold | OpType::QueryWarm => match code {
                    0 => "Disconnected",
                    1 => "Connected",
                    _ => "Invalid/Other",
                },
            };

            println!(
                "{:<24} | {:<8} | {:<10.2} | {:<10.2} | {:<8} | {:<8} | {:<8}",
                label,
                nanos_vec.len(),
                mean,
                std_dev,
                hist.value_at_quantile(0.5),
                hist.value_at_quantile(0.99),
                hist.max()
            );
        }
    }
}

// MARK: Data Preparation
struct BenchData {
    n: usize,
    all_edges: Vec<(usize, usize)>,
    del_edges: Vec<(usize, usize)>,
    empty_map: IntMap<usize, IntSet<usize>>,
    id_tree: IDTree,
    query_id_tree: IDTree,
    query_edges: Vec<(usize, usize)>,
}

impl BenchData {
    fn new(filename: &str) -> Self {
        let adj_list = BenchData::load_graph(filename);
        let mut adj_dict: IntMap<usize, IntSet<usize>> = IntMap::default();
        for &u in adj_list.keys() {
            adj_dict.entry(u).or_default();
            for &v in adj_list.get(&u).unwrap() {
                adj_dict.entry(v).or_default();
                adj_dict.get_mut(&u).unwrap().insert(v);
                adj_dict.get_mut(&v).unwrap().insert(u);
            }
        }

        let mut empty_map: IntMap<usize, IntSet<usize>> = IntMap::default();
        for &u in adj_list.keys() {
            empty_map.entry(u).or_default();
            for &v in adj_list.get(&u).unwrap() {
                empty_map.entry(v).or_default();
            }
        }

        let mut all_edges: Vec<(usize, usize)> = adj_list
            .iter()
            .flat_map(|(&u, neighbors)| neighbors.iter().map(move |&v| (u as usize, v as usize)))
            .collect();

        let mut rng = StdRng::seed_from_u64(12345);
        all_edges.shuffle(&mut rng);

        let dnd_tree = IDTree::new(&adj_dict);

        let n = adj_dict.len();
        let mut query_edges = Vec::new();
        for _ in 0..1000 {
            let u = rng.random_range(0..n);
            let v = rng.random_range(0..n);
            if u == v {
                continue;
            }
            query_edges.push((u, v));
        }

        // Delete some of the edges to create cold trees
        let deleted_count = all_edges.len() / 5;
        let del_edges = all_edges
            .iter()
            .take(deleted_count)
            .cloned()
            .collect::<Vec<_>>();

        let mut query_dnd_tree = dnd_tree.clone();

        for &(u, v) in del_edges.iter() {
            query_dnd_tree.delete_edge(u, v);
        }

        BenchData {
            n,
            all_edges,
            del_edges,
            empty_map,
            id_tree: dnd_tree,
            query_id_tree: query_dnd_tree,
            query_edges,
        }
    }

    fn load_graph(filename: &str) -> IntMap<usize, Vec<usize>> {
        let manifest_dir = env!("CARGO_MANIFEST_DIR");
        let mtx_path = PathBuf::from(manifest_dir)
            .join("benches")
            .join("data")
            .join(filename);
        let reader = BufReader::new(File::open(mtx_path).expect("MTX file missing"));

        let mut adj_list: IntMap<usize, Vec<usize>> = IntMap::default();
        let mut data_started = false;

        for line in reader.lines().map_while(Result::ok) {
            let trimmed = line.trim();
            if trimmed.is_empty() || trimmed.starts_with('%') {
                continue;
            }
            if !data_started {
                data_started = true;
                continue;
            }

            let parts: Vec<&str> = trimmed.split_whitespace().collect();
            if parts.len() >= 2 {
                let mut u: usize = parts[0].parse().unwrap();
                let mut v: usize = parts[1].parse().unwrap();
                // Canonicalize
                if u > v {
                    std::mem::swap(&mut u, &mut v);
                }
                // MTX is 1-based; decrement to 0-based.
                // Only add once as the graph is undirected and insert_edge handles symmetry.
                adj_list.entry(u - 1).or_default().push(v - 1);
            }
        }
        adj_list
    }
}

fn setup_cpp_tree(
    n: usize,
    edges: &[(usize, usize)],
    use_dsu: bool,
) -> cxx::UniquePtr<ffi::CPPDNDTree> {
    let mut adj = vec![vec![]; n];
    for &(u, v) in edges {
        if u < n && v < n {
            adj[u as usize].push(v);
            adj[v as usize].push(u);
        }
    }

    let mut degrees = Vec::with_capacity(n);
    let mut flat_neighbors = Vec::new();
    for neighbors in &adj {
        degrees.push(neighbors.len() as i32);
        for &v in neighbors {
            flat_neighbors.push(v as i32);
        }
    }

    ffi::new_cpp_dndtree_from_flat_adj(n as i32, &degrees, &flat_neighbors, use_dsu)
}

// MARK: Benchmarks

fn trace_insertion(task: Task, data: &BenchData) -> Vec<(i32, usize)> {
    if task.variant == TaskVariant::CPPDNDTree {
        let tree = setup_cpp_tree(data.n, &[], true);
        let mut trace = Vec::with_capacity(data.all_edges.len());

        for &(u, v) in data.all_edges.iter() {
            let time = Instant::now();
            let res = tree.insert_edge(u as i32, v as i32);
            let elapsed = time.elapsed().as_nanos() as usize;
            trace.push((res, elapsed));
        }

        return trace;
    }

    let mut tree = IDTree::new(&data.empty_map);
    let mut trace = Vec::with_capacity(data.all_edges.len());

    for &(u, v) in data.all_edges.iter() {
        let time = Instant::now();
        let res = tree.insert_edge(u, v);
        let elapsed = time.elapsed().as_nanos() as usize;
        trace.push((res, elapsed));
    }

    trace
}

fn trace_query_cold(task: Task, data: &BenchData) -> Vec<(i32, usize)> {
    if task.variant == TaskVariant::CPPDNDTree {
        let tree = setup_cpp_tree(data.n, &data.all_edges, true);
        let mut trace = Vec::with_capacity(data.all_edges.len());

        for &(u, v) in data.del_edges.iter() {
            tree.delete_edge(u as i32, v as i32);
        }

        for &(u, v) in data.query_edges.iter() {
            let time = Instant::now();
            let res = tree.query(u as i32, v as i32);
            let elapsed = time.elapsed().as_nanos() as usize;
            trace.push((res as i32, elapsed));
        }

        return trace;
    }

    let tree = match task.variant {
        TaskVariant::IDTree => data.query_id_tree.clone(),
        _ => unreachable!(),
    };
    let mut trace = Vec::with_capacity(data.query_edges.len());

    for &(u, v) in data.query_edges.iter() {
        let time = Instant::now();
        let res = tree.query(u, v);
        let elapsed = time.elapsed().as_nanos() as usize;
        trace.push((res as i32, elapsed));
    }
    trace
}

fn trace_query_warm(task: Task, data: &BenchData) -> Vec<(i32, usize)> {
    if task.variant == TaskVariant::CPPDNDTree {
        let tree = setup_cpp_tree(data.n, &data.all_edges, true);
        for &(u, v) in data.del_edges.iter() {
            tree.delete_edge(u as i32, v as i32);
        }

        // run through one time to warm up
        for &(u, v) in data.query_edges.iter() {
            tree.query(u as i32, v as i32);
        }

        let mut trace = Vec::with_capacity(data.query_edges.len());

        for &(u, v) in data.query_edges.iter() {
            let time = Instant::now();
            let res = tree.query(u as i32, v as i32);
            let elapsed = time.elapsed().as_nanos() as usize;
            trace.push((res as i32, elapsed));
        }

        return trace;
    }

    let tree = match task.variant {
        TaskVariant::IDTree => data.query_id_tree.clone(),
        _ => unreachable!(),
    };
    let mut trace = Vec::with_capacity(data.query_edges.len());

    for &(u, v) in data.query_edges.iter() {
        tree.query(u, v);
    }

    for &(u, v) in data.query_edges.iter() {
        let time = Instant::now();
        let res = tree.query(u, v);
        let elapsed = time.elapsed().as_nanos() as usize;
        trace.push((res as i32, elapsed));
    }
    trace
}

fn trace_delete(task: Task, data: &BenchData) -> Vec<(i32, usize)> {
    if task.variant == TaskVariant::CPPDNDTree {
        let tree = setup_cpp_tree(data.n, &data.all_edges, true);
        let mut trace = Vec::with_capacity(data.all_edges.len());

        for &(u, v) in data.all_edges.iter() {
            let time = Instant::now();
            let res = tree.delete_edge(u as i32, v as i32);
            let elapsed = time.elapsed().as_nanos() as usize;
            trace.push((res as i32, elapsed));
        }

        return trace;
    }

    let mut tree = match task.variant {
        TaskVariant::IDTree => data.id_tree.clone(),
        _ => unreachable!(),
    };
    let mut trace = Vec::with_capacity(data.all_edges.len());

    for &(u, v) in data.all_edges.iter() {
        let time = Instant::now();
        let res = tree.delete_edge(u, v);
        let elapsed = time.elapsed().as_nanos() as usize;
        trace.push((res as i32, elapsed));
    }
    trace
}

fn bench_task(task: Task, data: &BenchData, sample_count: u32) {
    let mut sample_data = Vec::with_capacity(sample_count as usize);
    for _ in 0..sample_count {
        let traces = vec![
            trace_insertion(task, data),
            trace_query_cold(task, data),
            trace_query_warm(task, data),
            trace_delete(task, data),
        ];
        sample_data.push(traces);
    }

    report(task, sample_data);
}

fn profile(n: usize, filename: &str) {
    println!("\nPreparing {} data...", filename);

    let start_time = Instant::now();
    let bench_data = BenchData::new(filename);
    println!("Prepared in {} ms", start_time.elapsed().as_millis());

    let task = Task::new(TaskVariant::IDTree);
    bench_task(task, &bench_data, n as u32);
}

// Take argv arguments for n and mtx data file name
fn main() {
    use std::env;
    let args: Vec<String> = env::args().collect();

    let n: usize = args[1].parse().unwrap();
    let filename: &str = &args[2];

    let start_time = std::time::Instant::now();
    profile(n, filename);
    let elapsed = start_time.elapsed();

    println!("{} took {} microseconds", n, elapsed.as_micros());
}