probabilistic-rs 0.6.4

Probabilistic data structures in Rust
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
#![allow(clippy::uninlined_format_args)]
// mod common;
use probabilistic_rs::bloom::{
    BloomFilter, BloomFilterConfigBuilder, BloomFilterOps, BloomFilterStats,
    BulkBloomFilterOps, PersistenceConfigBuilder,
};
use probabilistic_rs::common::bits2hr;
use std::collections::HashSet;
use std::path::PathBuf;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Initialize tracing (suppress verbose logs)
    tracing_subscriber::fmt()
        .with_max_level(tracing::Level::WARN)
        .with_env_filter(
            tracing_subscriber::EnvFilter::new("warn")
                .add_directive("fjall=off".parse()?)
                .add_directive("lsm_tree=off".parse()?),
        )
        .with_target(false)
        .init();

    println!("🌸 Core Bloom Filter Example");
    println!("==============================");

    // Demonstrate basic usage
    basic_workflow_example().await?;

    // Demonstrate false positive rate measurement
    false_positive_rate_example().await?;

    // Demonstrate capacity limits
    capacity_limits_example().await?;

    // Demonstrate database persistence
    persistence_example().await?;

    // Demonstrate bulk operations (if available)
    bulk_operations_example().await?;

    Ok(())
}

async fn basic_workflow_example() -> Result<(), Box<dyn std::error::Error>> {
    println!("\n📝 Basic Workflow Example");
    println!("---------------------------");

    // Create a bloom filter configuration
    let config = BloomFilterConfigBuilder::default()
        .capacity(1_000_000)
        .false_positive_rate(0.01) // 1%
        .build()?;

    let filter = BloomFilter::create(config).await?;

    println!("Created bloom filter:");
    println!("  Capacity: {}", filter.capacity());
    println!("  Target FPR: {:.2}%", filter.false_positive_rate() * 100.0);
    println!("  Bit vector size: {} bits", filter.bit_vector_size);
    println!(
        "  Bit vector size in memory: {}",
        filter.approx_memory_bits()
    );
    println!("  Bits per item: {:.2}", filter.bits_per_item());
    println!("  Bit vector size: {}", bits2hr(filter.bit_vector_size));
    println!("  Hash functions: {}", filter.num_hashes);

    // Insert some items
    let items = vec!["apple", "banana", "cherry", "date", "elderberry"];

    for item in &items {
        filter.insert(item.as_bytes())?;
        println!("  ✅ Inserted: {}", item);
    }

    println!("\nQuerying items:");
    // Query the items we inserted
    for item in &items {
        let exists = filter.contains(item.as_bytes())?;
        println!("  {} exists: {}", item, if exists { "" } else { "" });
    }

    // Query items we didn't insert
    let test_items = vec!["grape", "kiwi", "mango"];
    for item in &test_items {
        let exists = filter.contains(item.as_bytes())?;
        println!(
            "  {} exists: {}",
            item,
            if exists {
                "🟡 (false positive?)"
            } else {
                ""
            }
        );
    }

    println!("  Inserted elements inserted: {}", filter.insert_count());

    Ok(())
}

async fn false_positive_rate_example() -> Result<(), Box<dyn std::error::Error>> {
    println!("\n📊 False Positive Rate Measurement");
    println!("-----------------------------------");

    let config = BloomFilterConfigBuilder::default()
        .capacity(1_000)
        .false_positive_rate(0.05) // 5%
        .build()?;

    let filter = BloomFilter::create(config).await?;

    // Insert 500 known items (50% capacity)
    let mut inserted_items = HashSet::new();
    for i in 0..500 {
        let item = format!("item_{:04}", i);
        filter.insert(item.as_bytes())?;
        inserted_items.insert(item);
    }

    println!("Inserted {} items into filter", inserted_items.len());

    // Test for false positives with 1000 random items
    let mut false_positives = 0;
    let test_count = 1000;

    for i in 1000..1000 + test_count {
        let test_item = format!("test_{:04}", i);
        if filter.contains(test_item.as_bytes())? {
            // Make sure this isn't actually a known item
            if !inserted_items.contains(&test_item) {
                false_positives += 1;
            }
        }
    }

    let measured_fpr = false_positives as f64 / test_count as f64;
    let target_fpr = filter.false_positive_rate();

    println!("False positive rate analysis:");
    println!(
        "  Target FPR: {:.4}% ({:.4})",
        target_fpr * 100.0,
        target_fpr
    );
    println!(
        "  Measured FPR: {:.4}% ({:.4})",
        measured_fpr * 100.0,
        measured_fpr
    );
    println!(
        "  Ratio (measured/target): {:.2}x",
        measured_fpr / target_fpr
    );
    println!(
        "  False positives found: {}/{}",
        false_positives, test_count
    );

    Ok(())
}

async fn capacity_limits_example() -> Result<(), Box<dyn std::error::Error>> {
    println!("\n⚠️  Capacity Limits & Performance");
    println!("----------------------------------");

    let config = BloomFilterConfigBuilder::default()
        .capacity(100) // Small capacity for demonstration
        .false_positive_rate(0.01)
        .build()?;

    let _ = BloomFilter::create(config).await?;

    println!("Testing with small capacity filter (100 items):");

    // Insert items up to and beyond capacity
    for fill_percentage in [25, 50, 75, 100, 150, 200] {
        let test_filter = BloomFilter::create(
            BloomFilterConfigBuilder::default()
                .capacity(100)
                .false_positive_rate(0.01)
                .build()?,
        )
        .await?;

        let items_to_insert = fill_percentage;

        // Insert items
        for i in 0..items_to_insert {
            let item = format!("load_test_{:03}", i);
            test_filter.insert(item.as_bytes())?;
        }

        // Measure false positive rate
        let mut fps = 0;
        let tests = 100;
        for i in 1000..(1000 + tests) {
            let test_item = format!("fp_test_{:03}", i);
            if test_filter.contains(test_item.as_bytes())? {
                fps += 1;
            }
        }

        let measured_fpr = fps as f64 / tests as f64;
        println!(
            "  {}% fill ({} items): FPR = {:.4}%",
            fill_percentage,
            items_to_insert,
            measured_fpr * 100.0
        );
    }

    println!(
        "\n💡 Observation: FPR increases significantly when exceeding capacity!"
    );

    Ok(())
}

async fn persistence_example() -> Result<(), Box<dyn std::error::Error>> {
    use std::fs;

    println!("\n🗄️  Database Persistence Example");
    println!("----------------------------------");

    // Ensure tmp directory exists
    fs::create_dir_all("tmp")?;
    let db_path = PathBuf::from("tmp/test_bloom_db.fjall");

    // Step 1: Create database (deleting previous if exists)
    println!("Step 1: Creating new database at {:?}", db_path);

    let persistence_config = PersistenceConfigBuilder::default()
        .db_path(db_path.clone())
        .chunk_size_bytes(1024) // 1KB chunks
        .build()?;

    let original_config = BloomFilterConfigBuilder::default()
        .capacity(50000)
        .false_positive_rate(0.02) // 2% FPR
        .persistence(Some(persistence_config))
        .build()?;

    println!(
        "  Original config - capacity: {}, FPR: {:.3}%",
        original_config.capacity,
        original_config.false_positive_rate * 100.0
    );

    let filter = BloomFilter::create(original_config.clone()).await?;

    // Insert some test data
    let test_items = ["apple", "banana", "cherry", "date", "elderberry"];
    for item in &test_items {
        filter.insert(item.as_bytes())?;
    }
    println!("  Inserted {} test items", test_items.len());

    // Save snapshot
    println!("  Saving snapshot to database...");
    filter.save_snapshot().await?;

    drop(filter); // Ensure everything is written

    // Step 2: Check database folder size and file count
    println!("\nStep 2: Analyzing database folder");
    if db_path.exists() {
        let metadata = fs::metadata(&db_path)?;
        if metadata.is_dir() {
            let entries: Vec<_> =
                fs::read_dir(&db_path)?.collect::<Result<Vec<_>, _>>()?;

            let total_size: u64 = entries
                .iter()
                .filter_map(|entry| entry.metadata().ok().map(|m| m.len()))
                .sum();

            println!("  Database folder: {:?}", db_path);
            println!("  File count: {}", entries.len());
            println!(
                "  Total size: {} bytes ({:.2} KB)",
                total_size,
                total_size as f64 / 1024.0
            );

            for entry in entries {
                let metadata = entry.metadata()?;
                println!(
                    "    - {}: {} bytes",
                    entry.file_name().to_string_lossy(),
                    metadata.len()
                );
            }
        }
    } else {
        println!(
            "  ⚠️  Database folder not found (expected for dummy implementation)"
        );
    }

    // Step 3: Load from database and verify config
    println!("\nStep 3: Loading from database and verifying config");

    let loaded_filter = BloomFilter::load(db_path.clone()).await?;
    let loaded_config = loaded_filter.config();

    println!(
        "  Loaded config - capacity: {}, FPR: {:.3}%",
        loaded_config.capacity,
        loaded_config.false_positive_rate * 100.0
    );

    // Verify that the data survived persistence
    println!("  Verifying persisted data:");
    for item in &test_items {
        let exists = loaded_filter.contains(item.as_bytes())?;
        println!("    {} exists: {}", item, if exists { "" } else { "" });
    }

    // Verify parameters match
    let capacity_match = original_config.capacity == loaded_config.capacity;
    let fpr_match = (original_config.false_positive_rate
        - loaded_config.false_positive_rate)
        .abs()
        < f64::EPSILON;

    println!("  Config verification:");
    println!(
        "    Capacity match: {} ({} == {})",
        if capacity_match { "" } else { "" },
        original_config.capacity,
        loaded_config.capacity
    );
    println!(
        "    FPR match: {} ({:.4} == {:.4})",
        if fpr_match { "" } else { "" },
        original_config.false_positive_rate,
        loaded_config.false_positive_rate
    );

    if capacity_match && fpr_match {
        println!("  🎉 All parameters match successfully!");
    } else {
        println!("  ❌ Parameter mismatch detected!");
    }

    // Test create_or_load behavior
    println!("\nStep 4: Testing create_or_load behavior");

    // Should load existing
    println!("  Testing create_or_load with existing DB...");
    let reloaded_filter =
        BloomFilter::create_or_load(original_config.clone()).await?;
    println!(
        "    Loaded existing - capacity: {}",
        reloaded_filter.capacity()
    );

    // Remove DB and test creation
    if db_path.exists() {
        fs::remove_dir_all(&db_path)?;
        println!("  Removed database for create test");
    }

    println!("  Testing create_or_load with missing DB...");
    let new_filter = BloomFilter::create_or_load(original_config.clone()).await?;
    println!("    Created new - capacity: {}", new_filter.capacity());

    println!("\n✅ Persistence example completed!");
    Ok(())
}

async fn bulk_operations_example() -> Result<(), Box<dyn std::error::Error>> {
    println!("\n⚡ Bulk Operations Example");
    println!("-------------------------");

    let config = BloomFilterConfigBuilder::default()
        .capacity(10_000)
        .false_positive_rate(0.01)
        .build()?;

    let filter = BloomFilter::create(config).await?;

    // Prepare bulk data
    let bulk_items: Vec<String> =
        (0..100).map(|i| format!("bulk_item_{:04}", i)).collect();

    let bulk_refs: Vec<&[u8]> = bulk_items.iter().map(|s| s.as_bytes()).collect();

    println!("Prepared {} items for bulk operations", bulk_items.len());

    // Test bulk insert
    println!("\n📝 Testing bulk insert...");
    let start = std::time::Instant::now();
    filter.insert_bulk(&bulk_refs)?;
    let bulk_insert_duration = start.elapsed();

    // Test bulk contains
    println!("Testing bulk contains...");
    let start = std::time::Instant::now();
    let results = filter.contains_bulk(&bulk_refs)?;
    let bulk_query_duration = start.elapsed();
    let found_count = results.iter().filter(|&&exists| exists).count();

    // Compare with individual operations
    println!("\n📊 Performance comparison:");

    // Individual insertions
    let test_filter = BloomFilter::create(
        BloomFilterConfigBuilder::default()
            .capacity(10_000)
            .false_positive_rate(0.01)
            .build()?,
    )
    .await?;

    let start = std::time::Instant::now();
    for item_bytes in &bulk_refs {
        test_filter.insert(item_bytes)?;
    }
    let individual_insert_duration = start.elapsed();

    // Individual queries
    let start = std::time::Instant::now();
    let mut individual_found_count = 0;
    for item_bytes in &bulk_refs {
        if test_filter.contains(item_bytes)? {
            individual_found_count += 1;
        }
    }
    let individual_query_duration = start.elapsed();

    // Calculate rates
    let bulk_insert_rate = if bulk_insert_duration.as_millis() > 0 {
        bulk_items.len() as f64 / bulk_insert_duration.as_millis() as f64
    } else {
        bulk_items.len() as f64
            / (bulk_insert_duration.as_micros() as f64 / 1000.0)
    };
    let bulk_query_rate = if bulk_query_duration.as_millis() > 0 {
        bulk_items.len() as f64 / bulk_query_duration.as_millis() as f64
    } else {
        bulk_items.len() as f64
            / (bulk_query_duration.as_micros() as f64 / 1000.0)
    };
    let individual_insert_rate = if individual_insert_duration.as_millis() > 0 {
        bulk_items.len() as f64 / individual_insert_duration.as_millis() as f64
    } else {
        bulk_items.len() as f64
            / (individual_insert_duration.as_micros() as f64 / 1000.0)
    };
    let individual_query_rate = if individual_query_duration.as_millis() > 0 {
        bulk_items.len() as f64 / individual_query_duration.as_millis() as f64
    } else {
        bulk_items.len() as f64
            / (individual_query_duration.as_micros() as f64 / 1000.0)
    };

    println!("\n🔧 Bulk Operations:");
    println!(
        "  Insert time: {:?} ({:.1} ops/ms)",
        bulk_insert_duration, bulk_insert_rate
    );
    println!(
        "  Query time:  {:?} ({:.1} ops/ms)",
        bulk_query_duration, bulk_query_rate
    );
    println!("  Items found: {}/{}", found_count, bulk_items.len());

    println!("\n🔧 Individual Operations:");
    println!(
        "  Insert time: {:?} ({:.1} ops/ms)",
        individual_insert_duration, individual_insert_rate
    );
    println!(
        "  Query time:  {:?} ({:.1} ops/ms)",
        individual_query_duration, individual_query_rate
    );
    println!(
        "  Items found: {}/{}",
        individual_found_count,
        bulk_items.len()
    );

    println!("\n📈 Performance Improvement:");
    let insert_speedup = individual_insert_duration.as_nanos() as f64
        / bulk_insert_duration.as_nanos() as f64;
    let query_speedup = individual_query_duration.as_nanos() as f64
        / bulk_query_duration.as_nanos() as f64;
    println!("  Insert speedup: {:.2}x", insert_speedup);
    println!("  Query speedup:  {:.2}x", query_speedup);

    // Test some items that weren't inserted
    let test_items: Vec<String> = (1000..1010)
        .map(|i| format!("test_item_{:04}", i))
        .collect();
    let test_refs: Vec<&[u8]> = test_items.iter().map(|s| s.as_bytes()).collect();

    let test_results = filter.contains_bulk(&test_refs)?;
    let false_positives = test_results.iter().filter(|&&exists| exists).count();

    println!(
        "\n🎯 False positives: {}/{} test items",
        false_positives,
        test_items.len()
    );

    println!("\n✅ Bulk operations implemented and working!");

    Ok(())
}