schiebung 0.5.0

Fast, memory-safe transform buffer for robotics
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
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
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
use criterion::{criterion_group, criterion_main, BenchmarkId, Criterion};
use nalgebra::Isometry3;
use schiebung::{BufferTree, StampedIsometry, TransformType, TransformUpdate};
use std::hint::black_box;

// ============================================================================
// Setup Helpers
// ============================================================================

/// Create a simple 2-frame buffer (A -> B) with dynamic transforms
fn setup_simple_dynamic_buffer() -> BufferTree {
    let mut buffer = BufferTree::new();

    // Fill buffer with 100 timestamped transforms
    for i in 0..100 {
        let isometry = StampedIsometry::new(
            [i as f64, 0.0, 0.0],
            [0.0, 0.0, 0.0, 1.0],
            (i as i64) * 100_000_000,
        );
        buffer
            .update(&[TransformUpdate::new(
                "frame_a",
                "frame_b",
                isometry,
                TransformType::Dynamic,
            )])
            .unwrap();
    }

    buffer
}

/// Create a simple 2-frame buffer (A -> B) with static transform
fn setup_simple_static_buffer() -> BufferTree {
    let mut buffer = BufferTree::new();

    let isometry = StampedIsometry::new([1.0, 0.0, 0.0], [0.0, 0.0, 0.0, 1.0], 0);
    buffer
        .update(&[TransformUpdate::new(
            "frame_a",
            "frame_b",
            isometry,
            TransformType::Static,
        )])
        .unwrap();

    buffer
}

/// Create a deep tree: A -> N1 -> N2 -> ... -> N99 -> E (100 edges total)
fn setup_deep_tree() -> BufferTree {
    let mut buffer = BufferTree::new();

    for i in 0..100 {
        let isometry = StampedIsometry::new([1.0, 0.0, 0.0], [0.0, 0.0, 0.0, 1.0], 0);
        let target_name = if i == 99 {
            "E".to_string()
        } else {
            format!("N{}", i + 1)
        };
        let source_name = if i == 0 {
            "A".to_string()
        } else {
            format!("N{}", i)
        };

        buffer
            .update(&[TransformUpdate::new(
                source_name,
                target_name,
                isometry,
                TransformType::Static,
            )])
            .unwrap();
    }

    buffer
}

/// Create a wide tree: root with N children
fn setup_wide_tree(num_children: usize) -> BufferTree {
    let mut buffer = BufferTree::new();

    for i in 0..num_children {
        let isometry = StampedIsometry::new([i as f64, 0.0, 0.0], [0.0, 0.0, 0.0, 1.0], 0);
        buffer
            .update(&[TransformUpdate::new(
                "root",
                format!("child_{}", i),
                isometry,
                TransformType::Static,
            )])
            .unwrap();
    }

    buffer
}

// ============================================================================
// Update Benchmarks
// ============================================================================

fn bench_update_new_edge(c: &mut Criterion) {
    c.bench_function("update/new_edge_static", |b| {
        b.iter_batched(
            || BufferTree::new(),
            |mut buffer| {
                let isometry = StampedIsometry::new([1.0, 0.0, 0.0], [0.0, 0.0, 0.0, 1.0], 0);
                buffer
                    .update(black_box(&[TransformUpdate::new(
                        "frame_a",
                        "frame_b",
                        isometry,
                        TransformType::Static,
                    )]))
                    .unwrap();
            },
            criterion::BatchSize::SmallInput,
        )
    });

    c.bench_function("update/existing_edge_dynamic", |b| {
        let mut buffer = BufferTree::new();
        let isometry = StampedIsometry::new([1.0, 0.0, 0.0], [0.0, 0.0, 0.0, 1.0], 0);
        buffer
            .update(&[TransformUpdate::new(
                "frame_a",
                "frame_b",
                isometry,
                TransformType::Dynamic,
            )])
            .unwrap();

        let mut t = 1_000_000_000i64;
        b.iter(|| {
            t += 100_000_000;
            let isometry = StampedIsometry::new([1.0, 0.0, 0.0], [0.0, 0.0, 0.0, 1.0], t);
            buffer
                .update(black_box(&[TransformUpdate::new(
                    "frame_a",
                    "frame_b",
                    isometry,
                    TransformType::Dynamic,
                )]))
                .unwrap();
        })
    });
}

/// Benchmark: insert N edges in a single batch vs N single-element calls.
/// Mirrors the "many edges, one stamp" workload that motivated the batch API.
fn bench_update_batch(c: &mut Criterion) {
    let mut group = c.benchmark_group("update_batch");

    for batch_size in [1usize, 10, 100, 1000].iter() {
        // Single batched call
        group.bench_with_input(
            BenchmarkId::new("one_call", batch_size),
            batch_size,
            |b, &batch_size| {
                let updates: Vec<TransformUpdate> = (0..batch_size)
                    .map(|i| {
                        TransformUpdate::new(
                            "root",
                            format!("child_{}", i),
                            StampedIsometry::new(
                                [i as f64, 0.0, 0.0],
                                [0.0, 0.0, 0.0, 1.0],
                                1_000_000_000,
                            ),
                            TransformType::Static,
                        )
                    })
                    .collect();

                b.iter_batched(
                    || (BufferTree::new(), updates.clone()),
                    |(mut buffer, updates)| {
                        buffer.update(black_box(&updates)).unwrap();
                    },
                    criterion::BatchSize::SmallInput,
                );
            },
        );

        // N separate single-element calls (for comparison)
        group.bench_with_input(
            BenchmarkId::new("n_calls", batch_size),
            batch_size,
            |b, &batch_size| {
                b.iter_batched(
                    || BufferTree::new(),
                    |mut buffer| {
                        for i in 0..batch_size {
                            buffer
                                .update(&[TransformUpdate::new(
                                    "root",
                                    format!("child_{}", i),
                                    StampedIsometry::new(
                                        [i as f64, 0.0, 0.0],
                                        [0.0, 0.0, 0.0, 1.0],
                                        1_000_000_000,
                                    ),
                                    TransformType::Static,
                                )])
                                .unwrap();
                        }
                    },
                    criterion::BatchSize::SmallInput,
                );
            },
        );
    }

    group.finish();
}

// ============================================================================
// Lookup Transform Benchmarks
// ============================================================================

fn bench_lookup_transform(c: &mut Criterion) {
    let buffer = setup_simple_dynamic_buffer();

    c.bench_function("lookup_transform/simple_interpolated", |b| {
        b.iter(|| {
            buffer
                .lookup_transform(
                    black_box("frame_a"),
                    black_box("frame_b"),
                    black_box(5_000_000_000),
                )
                .unwrap()
        })
    });

    let buffer_static = setup_simple_static_buffer();
    c.bench_function("lookup_transform/simple_static", |b| {
        b.iter(|| {
            buffer_static
                .lookup_transform(black_box("frame_a"), black_box("frame_b"), black_box(0))
                .unwrap()
        })
    });
}

fn bench_lookup_latest_transform(c: &mut Criterion) {
    let buffer = setup_simple_dynamic_buffer();

    c.bench_function("lookup_latest_transform/simple", |b| {
        b.iter(|| {
            buffer
                .lookup_latest_transform(black_box("frame_a"), black_box("frame_b"))
                .unwrap()
        })
    });
}

fn bench_lookup_deep_tree(c: &mut Criterion) {
    let buffer = setup_deep_tree();

    c.bench_function("lookup_latest_transform/deep_100_edges", |b| {
        b.iter(|| {
            buffer
                .lookup_latest_transform(black_box("A"), black_box("E"))
                .unwrap()
        })
    });

    c.bench_function("lookup_transform/deep_100_edges", |b| {
        b.iter(|| {
            buffer
                .lookup_transform(black_box("A"), black_box("E"), black_box(0))
                .unwrap()
        })
    });
}

fn bench_lookup_scaling(c: &mut Criterion) {
    let mut group = c.benchmark_group("lookup_scaling");

    for depth in [2, 5, 10, 20, 50, 100].iter() {
        let mut buffer = BufferTree::new();
        for i in 0..*depth {
            let isometry = StampedIsometry::new([1.0, 0.0, 0.0], [0.0, 0.0, 0.0, 1.0], 0);
            let target = if i == depth - 1 {
                "end".to_string()
            } else {
                format!("n{}", i + 1)
            };
            let source = if i == 0 {
                "start".to_string()
            } else {
                format!("n{}", i)
            };
            buffer
                .update(&[TransformUpdate::new(
                    source,
                    target,
                    isometry,
                    TransformType::Static,
                )])
                .unwrap();
        }

        group.bench_with_input(BenchmarkId::from_parameter(depth), depth, |b, _| {
            b.iter(|| {
                buffer
                    .lookup_latest_transform(black_box("start"), black_box("end"))
                    .unwrap()
            })
        });
    }

    group.finish();
}

// ============================================================================
// Path Finding Benchmarks (Internal)
// ============================================================================

fn bench_path_finding(c: &mut Criterion) {
    // Note: find_path is private, so we benchmark it indirectly through lookup_latest_transform
    // but isolate just the path finding cost by using static transforms

    let buffer_simple = setup_simple_static_buffer();
    c.bench_function("path_finding/simple_2_nodes", |b| {
        b.iter(|| {
            // This isolates path finding + minimal transform computation
            buffer_simple
                .lookup_latest_transform(black_box("frame_a"), black_box("frame_b"))
                .unwrap()
        })
    });

    let buffer_deep = setup_deep_tree();
    c.bench_function("path_finding/deep_100_nodes", |b| {
        b.iter(|| {
            buffer_deep
                .lookup_latest_transform(black_box("A"), black_box("E"))
                .unwrap()
        })
    });

    // Wide tree: test LCA finding with many siblings
    let buffer_wide = setup_wide_tree(50);
    c.bench_function("path_finding/wide_50_siblings", |b| {
        b.iter(|| {
            buffer_wide
                .lookup_latest_transform(black_box("child_0"), black_box("child_49"))
                .unwrap()
        })
    });
}

// ============================================================================
// Baseline: Raw nalgebra Operations
// ============================================================================

fn bench_raw_nalgebra(c: &mut Criterion) {
    let transforms: Vec<Isometry3<f64>> = (0..100)
        .map(|i| Isometry3::translation(i as f64, 0.0, 0.0))
        .collect();

    c.bench_function("baseline/nalgebra_100_mults", |b| {
        b.iter(|| {
            let mut result = Isometry3::identity();
            for t in &transforms {
                result *= t;
            }
            black_box(result)
        })
    });

    c.bench_function("baseline/nalgebra_single_mult", |b| {
        let t1 = Isometry3::translation(1.0, 0.0, 0.0);
        let t2 = Isometry3::translation(0.0, 1.0, 0.0);
        b.iter(|| {
            let result = black_box(t1) * black_box(t2);
            black_box(result)
        })
    });
}

// ============================================================================
// TransformHistory Scaling Benchmarks
// ============================================================================

/// Create a buffer with a specified number of dynamic transforms
fn setup_buffer_with_history(num_entries: usize) -> BufferTree {
    let mut buffer = BufferTree::new();

    // Simulate 1kHz updates (1ms = 1_000_000 ns)
    for i in 0..num_entries {
        let timestamp = (i as i64) * 1_000_000; // 1ms intervals
        let isometry = StampedIsometry::new(
            [i as f64 * 0.001, 0.0, 0.0],
            [0.0, 0.0, 0.0, 1.0],
            timestamp,
        );
        buffer
            .update(&[TransformUpdate::new(
                "frame_a",
                "frame_b",
                isometry,
                TransformType::Dynamic,
            )])
            .unwrap();
    }

    buffer
}

fn bench_history_update_scaling(c: &mut Criterion) {
    let mut group = c.benchmark_group("history_update_scaling");

    // Test update performance as history grows
    // Sizes: 100, 1k, 10k, 60k (1 min @ 1kHz), 120k (2 min @ 1kHz)
    for size in [100, 1_000, 10_000, 60_000, 120_000].iter() {
        group.bench_with_input(BenchmarkId::from_parameter(size), size, |b, &size| {
            let mut buffer = setup_buffer_with_history(size);
            let mut t = (size as i64) * 1_000_000;

            b.iter(|| {
                t += 1_000_000; // Next millisecond
                let isometry =
                    StampedIsometry::new([t as f64 * 0.000001, 0.0, 0.0], [0.0, 0.0, 0.0, 1.0], t);
                buffer
                    .update(black_box(&[TransformUpdate::new(
                        "frame_a",
                        "frame_b",
                        isometry,
                        TransformType::Dynamic,
                    )]))
                    .unwrap();
            })
        });
    }

    group.finish();
}

fn bench_history_lookup_scaling(c: &mut Criterion) {
    let mut group = c.benchmark_group("history_lookup_scaling");

    // Test lookup performance with different history sizes
    for size in [100, 1_000, 10_000, 60_000, 120_000].iter() {
        let buffer = setup_buffer_with_history(*size);

        // Lookup at middle of history (requires interpolation)
        let mid_timestamp = (*size as i64 / 2) * 1_000_000;

        group.bench_with_input(BenchmarkId::new("interpolated_mid", size), size, |b, _| {
            b.iter(|| {
                buffer
                    .lookup_transform(
                        black_box("frame_a"),
                        black_box("frame_b"),
                        black_box(mid_timestamp),
                    )
                    .unwrap()
            })
        });

        // Lookup at end of history (latest)
        group.bench_with_input(BenchmarkId::new("latest", size), size, |b, _| {
            b.iter(|| {
                buffer
                    .lookup_latest_transform(black_box("frame_a"), black_box("frame_b"))
                    .unwrap()
            })
        });

        // Lookup at beginning of history
        let start_timestamp = 0i64;
        group.bench_with_input(
            BenchmarkId::new("interpolated_start", size),
            size,
            |b, _| {
                b.iter(|| {
                    buffer
                        .lookup_transform(
                            black_box("frame_a"),
                            black_box("frame_b"),
                            black_box(start_timestamp),
                        )
                        .unwrap()
                })
            },
        );
    }

    group.finish();
}

fn bench_history_interpolation_positions(c: &mut Criterion) {
    let mut group = c.benchmark_group("history_interpolation_positions");

    // Use a large history (120k entries = 120 seconds @ 1kHz)
    let buffer = setup_buffer_with_history(120_000);
    let max_time = 120_000i64 * 1_000_000;

    // Test interpolation at different positions in the history
    for position_pct in [0, 10, 25, 50, 75, 90].iter() {
        let timestamp = (max_time * (*position_pct as i64)) / 100;

        group.bench_with_input(
            BenchmarkId::new("position_pct", position_pct),
            position_pct,
            |b, _| {
                b.iter(|| {
                    buffer
                        .lookup_transform(
                            black_box("frame_a"),
                            black_box("frame_b"),
                            black_box(timestamp),
                        )
                        .unwrap()
                })
            },
        );
    }

    group.finish();
}

// ============================================================================
// Criterion Groups
// ============================================================================

criterion_group!(update_benches, bench_update_new_edge, bench_update_batch,);

criterion_group!(
    lookup_benches,
    bench_lookup_transform,
    bench_lookup_latest_transform,
    bench_lookup_deep_tree,
    bench_lookup_scaling,
);

criterion_group!(path_benches, bench_path_finding,);

criterion_group!(
    history_benches,
    bench_history_update_scaling,
    bench_history_lookup_scaling,
    bench_history_interpolation_positions,
);

criterion_group!(baseline_benches, bench_raw_nalgebra,);

criterion_main!(
    update_benches,
    lookup_benches,
    path_benches,
    history_benches,
    baseline_benches
);