mctrust 0.2.1

Production-grade Monte Carlo Tree Search with UCT, RAVE, and pluggable environments
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
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
//! Adversarial edge case tests for mctrust
//!
//! These tests are designed to break the crate by testing:
//! - Zero arms
//! - Single arm
//! - Explore constant of 0
//! - Explore constant of infinity
//! - NaN rewards
//! - Negative rewards
//! - Concurrent observe calls
//! - Max u32 visits

#![allow(
    clippy::cast_possible_truncation,
    clippy::cast_lossless,
    clippy::float_cmp
)]

use crate::*;
use std::sync::Arc;
use std::thread;

// =============================================================================
// Zero Arms Tests
// =============================================================================

#[test]
fn bandit_with_zero_arms() {
    let mut search = BanditSearch::new(BanditConfig::default());

    // No arms added
    let arm = search.next_arm();

    assert!(arm.is_none(), "Bandit with no arms should return None");
}

#[test]
fn bandit_group_stats_with_zero_arms() {
    let search = BanditSearch::new(BanditConfig::default());

    let stats = search.group_stats();

    assert!(stats.is_empty(), "Stats should be empty with no arms");
}

#[test]
fn bandit_total_pulls_with_zero_arms() {
    let search = BanditSearch::new(BanditConfig::default());

    assert_eq!(search.total_pulls(), 0, "Total pulls should be 0");
}

// =============================================================================
// Single Arm Tests
// =============================================================================

#[test]
fn bandit_with_single_arm() {
    let mut search = BanditSearch::new(BanditConfig::default());
    search.add_arm(0, 0);

    let arm1 = search.next_arm();
    assert_eq!(arm1, Some(0), "Should return the single arm");

    // After pulling the only arm, should return None
    let arm2 = search.next_arm();
    assert!(
        arm2.is_none(),
        "Should return None after single arm is exhausted"
    );
}

#[test]
fn bandit_single_arm_with_observe() {
    let mut search = BanditSearch::new(BanditConfig::default());
    search.add_arm(42, 0);

    let arm = search.next_arm().unwrap();
    search.observe(arm, 1.0);

    let stats = search.group_stats();
    assert_eq!(stats.len(), 1);
    assert_eq!(stats[0].visits, 1);
    assert_eq!(stats[0].average_reward, 1.0);
}

// =============================================================================
// Explore Constant Tests
// =============================================================================

#[test]
fn bandit_exploration_constant_zero() {
    let config = BanditConfig::builder().exploration_constant(0.0).build();

    let mut search = BanditSearch::new_seeded(config, 42);

    for i in 0..10u64 {
        search.add_arm(i, (i / 3) as u32);
    }

    // With exploration constant 0, it should still work (pure exploitation after first visit)
    let arm = search.next_arm();
    assert!(arm.is_some());

    search.observe(arm.unwrap(), 0.5);
}

#[test]
fn bandit_exploration_constant_infinity() {
    let config = BanditConfig::builder()
        .exploration_constant(f64::INFINITY)
        .build();

    let mut search = BanditSearch::new_seeded(config, 42);

    for i in 0..10u64 {
        search.add_arm(i, (i / 3) as u32);
    }

    // With infinite exploration constant, behavior depends on implementation
    // The UCT formula should handle this (exploration term will dominate)
    let arm = search.next_arm();
    assert!(arm.is_some());
}

#[test]
fn bandit_exploration_constant_nan() {
    let config = BanditConfig::builder()
        .exploration_constant(f64::NAN)
        .build();

    let mut search = BanditSearch::new_seeded(config, 42);

    for i in 0..10u64 {
        search.add_arm(i, (i / 3) as u32);
    }

    // With NaN exploration constant, behavior is undefined
    // This may panic or return unexpected results
    let _arm = search.next_arm();
    // The result depends on how NaN propagates through the UCT formula
}

#[test]
fn bandit_exploration_constant_negative() {
    let config = BanditConfig::builder().exploration_constant(-1.0).build();

    let mut search = BanditSearch::new_seeded(config, 42);

    for i in 0..10u64 {
        search.add_arm(i, (i / 3) as u32);
    }

    // Negative exploration constant should still work (exploration becomes negative)
    let arm = search.next_arm();
    assert!(arm.is_some());
}

// =============================================================================
// RAVE Bias Tests
// =============================================================================

#[test]
fn bandit_rave_bias_zero() {
    let config = BanditConfig::builder().rave_bias(0.0).build();

    let mut search = BanditSearch::new_seeded(config, 42);

    for i in 0..10u64 {
        search.add_arm(i, (i / 5) as u32);
    }

    let arm1 = search.next_arm().unwrap();
    search.observe(arm1, 1.0);

    let arm2 = search.next_arm().unwrap();
    search.observe(arm2, 1.0);

    // Fixed: RAVE updates are now skipped when rave_bias=0
    let stats = search.group_stats();
    let total_rave: u32 = stats.iter().map(|s| s.rave_visits).sum();
    assert_eq!(
        total_rave, 0,
        "RAVE visits should not increment when rave_bias=0"
    );
}

#[test]
fn bandit_rave_bias_infinity() {
    let config = BanditConfig::builder().rave_bias(f64::INFINITY).build();

    let mut search = BanditSearch::new_seeded(config, 42);

    for i in 0..10u64 {
        search.add_arm(i, (i / 5) as u32);
    }

    let arm = search.next_arm();
    assert!(arm.is_some());
}

// =============================================================================
// NaN and Infinity Reward Tests
// =============================================================================

#[test]
fn bandit_observe_nan_reward() {
    let mut search = BanditSearch::new_seeded(BanditConfig::default(), 42);

    search.add_arm(0, 0);

    let arm = search.next_arm().unwrap();
    search.observe(arm, f64::NAN);

    let stats = search.group_stats();
    assert_eq!(stats[0].visits, 1);
    // Average reward with NaN should be NaN
    assert!(
        stats[0].average_reward.is_nan(),
        "Average should be NaN when reward is NaN"
    );
}

#[test]
fn bandit_observe_infinity_reward() {
    let mut search = BanditSearch::new_seeded(BanditConfig::default(), 42);

    search.add_arm(0, 0);

    let arm = search.next_arm().unwrap();
    search.observe(arm, f64::INFINITY);

    let stats = search.group_stats();
    assert_eq!(stats[0].visits, 1);
    assert!(
        stats[0].average_reward.is_infinite(),
        "Average should be infinite"
    );
}

#[test]
fn bandit_observe_negative_infinity_reward() {
    let mut search = BanditSearch::new_seeded(BanditConfig::default(), 42);

    search.add_arm(0, 0);

    let arm = search.next_arm().unwrap();
    search.observe(arm, f64::NEG_INFINITY);

    let stats = search.group_stats();
    assert_eq!(stats[0].visits, 1);
    assert!(
        stats[0].average_reward.is_infinite() && stats[0].average_reward < 0.0,
        "Average should be negative infinite"
    );
}

#[test]
fn bandit_observe_negative_reward() {
    let mut search = BanditSearch::new_seeded(BanditConfig::default(), 42);

    search.add_arm(0, 0);

    let arm = search.next_arm().unwrap();
    search.observe(arm, -5.0);

    let stats = search.group_stats();
    assert_eq!(stats[0].visits, 1);
    assert_eq!(
        stats[0].average_reward, -5.0,
        "Negative reward should be accepted"
    );
}

#[test]
fn bandit_mixed_rewards_positive_and_negative() {
    let mut search = BanditSearch::new_seeded(BanditConfig::default(), 42);

    for i in 0..5u64 {
        search.add_arm(i, 0);
    }

    // Pull each arm with different rewards
    for i in 0..5u64 {
        let arm = search.next_arm().unwrap();
        let reward = if i % 2 == 0 { 1.0 } else { -1.0 };
        search.observe(arm, reward);
    }

    let stats = search.group_stats();
    assert_eq!(stats[0].total_arms, 5);
}

#[test]
fn bandit_observe_very_large_reward() {
    let mut search = BanditSearch::new_seeded(BanditConfig::default(), 42);

    search.add_arm(0, 0);

    let arm = search.next_arm().unwrap();
    search.observe(arm, 1e308); // Very large but not quite infinity

    let stats = search.group_stats();
    assert!(
        stats[0].average_reward > 1e307,
        "Very large reward should be preserved"
    );
}

#[test]
fn bandit_observe_very_small_reward() {
    let mut search = BanditSearch::new_seeded(BanditConfig::default(), 42);

    search.add_arm(0, 0);

    let arm = search.next_arm().unwrap();
    search.observe(arm, 1e-308); // Very small positive

    let stats = search.group_stats();
    assert!(
        stats[0].average_reward > 0.0 && stats[0].average_reward < 1e-307,
        "Very small reward should be preserved"
    );
}

// =============================================================================
// Concurrent Access Tests
// =============================================================================

#[test]
fn bandit_concurrent_observe_calls() {
    let search = Arc::new(std::sync::Mutex::new(BanditSearch::new_seeded(
        BanditConfig::default(),
        42,
    )));

    // Add 200 arms so all threads can pull
    {
        let mut s = search.lock().unwrap();
        for i in 0..200u64 {
            s.add_arm(i, (i / 50) as u32);
        }
    }

    let mut handles = vec![];

    for thread_id in 0..10 {
        let search = Arc::clone(&search);
        handles.push(thread::spawn(move || {
            for _ in 0..10 {
                let mut s = search.lock().unwrap();
                if let Some(arm) = s.next_arm() {
                    s.observe(arm, thread_id as f64 * 0.1);
                }
            }
        }));
    }

    for handle in handles {
        handle.join().unwrap();
    }

    let s = search.lock().unwrap();
    assert_eq!(s.total_pulls(), 100, "Should have 100 total pulls");
}

// =============================================================================
// Max Visits Tests
// =============================================================================

#[test]
fn bandit_many_visits_u32_boundary() {
    let mut search = BanditSearch::new_seeded(BanditConfig::default(), 42);

    search.add_arm(0, 0);

    // Simulate many observations (not actually u32::MAX to keep test fast)
    for _ in 0..1000 {
        // We need to pull the arm first, then observe
        // But after first pull, next_arm returns None for exhausted arms
        // So we observe directly on arm 0
        search.observe(0, 0.5);
    }

    let stats = search.group_stats();
    assert_eq!(stats[0].visits, 1000);
}

// =============================================================================
// Group Bias Tests
// =============================================================================

#[test]
fn bandit_group_bias_infinity() {
    let mut search = BanditSearch::new_seeded(BanditConfig::default(), 42);

    for i in 0..10u64 {
        search.add_arm(i, (i / 5) as u32);
    }

    search.set_group_bias(1, f64::INFINITY);

    // First pull should come from group 1 due to infinite bias
    let arm = search.next_arm().unwrap();
    assert!(
        arm >= 5,
        "Infinite bias should force selection from group 1"
    );
}

#[test]
fn bandit_group_bias_nan() {
    let mut search = BanditSearch::new_seeded(BanditConfig::default(), 42);

    for i in 0..10u64 {
        search.add_arm(i, (i / 5) as u32);
    }

    search.set_group_bias(0, f64::NAN);

    // Behavior with NaN bias depends on implementation
    let arm = search.next_arm();
    assert!(arm.is_some());
}

#[test]
fn bandit_set_bias_for_nonexistent_group() {
    let mut search = BanditSearch::new_seeded(BanditConfig::default(), 42);

    search.add_arm(0, 0);

    // Setting bias for a group that doesn't exist should not panic
    search.set_group_bias(999, 100.0);

    let arm = search.next_arm();
    assert!(arm.is_some());
}

// =============================================================================
// Max Pulls Tests
// =============================================================================

#[test]
fn bandit_max_pulls_of_one() {
    let config = BanditConfig::builder().max_pulls(1).build();

    let mut search = BanditSearch::new_seeded(config, 42);

    for i in 0..10u64 {
        search.add_arm(i, 0);
    }

    let arm1 = search.next_arm();
    assert!(arm1.is_some());

    let arm2 = search.next_arm();
    assert!(arm2.is_none(), "Should return None after max_pulls reached");
}

#[test]
fn bandit_max_pulls_u64_max() {
    let config = BanditConfig::builder().max_pulls(u64::MAX).build();

    let mut search = BanditSearch::new_seeded(config, 42);

    search.add_arm(0, 0);

    // With max_pulls = u64::MAX, we should be able to pull many times
    for _ in 0..100 {
        let arm = search.next_arm();
        if arm.is_none() {
            break; // Arm exhausted
        }
    }

    // Total pulls should not exceed the number of unique arms
    assert!(search.total_pulls() <= 1);
}

// =============================================================================
// Checkpoint Tests
// =============================================================================

#[test]
fn bandit_checkpoint_empty() {
    let search = BanditSearch::new(BanditConfig::default());

    let checkpoint = search.checkpoint();
    let mut restored = BanditSearch::restore(checkpoint);

    assert_eq!(restored.total_pulls(), 0);
    assert!(restored.next_arm().is_none());
}

#[test]
fn bandit_checkpoint_with_observations() {
    let mut search = BanditSearch::new_seeded(BanditConfig::default(), 42);

    for i in 0..10u64 {
        search.add_arm(i, 0);
    }

    // Pull some arms
    for _ in 0..5 {
        let arm = search.next_arm().unwrap();
        search.observe(arm, 1.0);
    }

    let checkpoint = search.checkpoint();
    let restored = BanditSearch::restore(checkpoint);

    assert_eq!(restored.total_pulls(), 5);
}

// =============================================================================
// Add Arm Edge Cases
// =============================================================================

#[test]
fn bandit_add_duplicate_arm() {
    let mut search = BanditSearch::new_seeded(BanditConfig::default(), 42);

    search.add_arm(0, 0);
    search.add_arm(0, 0); // Duplicate

    let stats = search.group_stats();
    assert_eq!(stats[0].total_arms, 1, "Duplicate arm should not be added");
}

#[test]
fn bandit_add_arm_with_u32_max_group() {
    let mut search = BanditSearch::new_seeded(BanditConfig::default(), 42);

    search.add_arm(0, u32::MAX);

    let stats = search.group_stats();
    assert_eq!(stats[0].group_id, u32::MAX);
}

#[test]
fn bandit_add_arm_with_u64_max_arm_id() {
    let mut search = BanditSearch::new_seeded(BanditConfig::default(), 42);

    search.add_arm(u64::MAX, 0);

    let arm = search.next_arm();
    assert_eq!(arm, Some(u64::MAX));
}

#[test]
fn bandit_add_many_groups() {
    let mut search = BanditSearch::new_seeded(BanditConfig::default(), 42);

    // Add 1000 groups with 1 arm each
    for i in 0..1000u64 {
        search.add_arm(i, i as u32);
    }

    let stats = search.group_stats();
    assert_eq!(stats.len(), 1000);
}

#[test]
fn bandit_add_many_arms_single_group() {
    let mut search = BanditSearch::new_seeded(BanditConfig::default(), 42);

    // Add 1000 arms to a single group
    for i in 0..1000u64 {
        search.add_arm(i, 0);
    }

    let stats = search.group_stats();
    assert_eq!(stats.len(), 1);
    assert_eq!(stats[0].total_arms, 1000);
}

// =============================================================================
// Observe Nonexistent Arm Tests
// =============================================================================

#[test]
fn bandit_observe_nonexistent_arm() {
    let mut search = BanditSearch::new_seeded(BanditConfig::default(), 42);

    search.add_arm(0, 0);

    // Observing an arm that was never pulled (and doesn't exist in mapping)
    // This should not panic
    search.observe(999, 1.0);

    let stats = search.group_stats();
    assert_eq!(
        stats[0].visits, 0,
        "Nonexistent arm observation should not affect stats"
    );
}

#[test]
fn bandit_observe_before_next_arm() {
    let mut search = BanditSearch::new_seeded(BanditConfig::default(), 42);

    search.add_arm(0, 0);

    // Observing before pulling - arm exists in mapping
    search.observe(0, 1.0);

    let stats = search.group_stats();
    assert_eq!(stats[0].visits, 1);
}