rustkmer 0.5.2

High-performance k-mer counting tool 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

# Benchmark

**Module**: `rustkmer::cli::commands::benchmark`

## Overview

Comprehensive performance benchmarking command
Provides systematic performance testing and comparison capabilities
for RustKmer against Jellyfish across multiple dimensions.

## API Reference

### Structs

#### BenchmarkRunner

```rust
pub struct BenchmarkRunner {
```

Benchmark configuration and execution

### Fns

#### run_benchmark

```rust
pub fn run_benchmark(&self) -> ProcessingResult<()> {
```

Execute comprehensive benchmarking

#### find_test_files

```rust
fn find_test_files(&self) -> ProcessingResult<Vec<PathBuf>> {
```

Find test files in the data directory

#### find_or_create_databases

```rust
fn find_or_create_databases(&self, test_files: &[PathBuf]) -> ProcessingResult<Vec<PathBuf>> {
```

Find existing databases or create them

#### benchmark_file_reading

```rust
fn benchmark_file_reading(&self, file_path: &Path) -> ProcessingResult<BenchmarkResult> {
```

Benchmark file reading performance

#### generate_test_queries

```rust
fn generate_test_queries(&self, count: usize) -> Vec<String> {
```

Generate test queries

#### generate_fuzzy_queries

```rust
fn generate_fuzzy_queries(&self, count: usize) -> Vec<String> {
```

Generate fuzzy queries with wildcards

#### generate_summary

```rust
fn generate_summary(&self, results: &[BenchmarkResult], total_time: Duration) -> BenchmarkSummary {
```

Generate summary statistics

#### save_results

```rust
fn save_results(&self, results: &[BenchmarkResult], summary: &BenchmarkSummary) -> ProcessingResult<()> {
```

Save results to files

#### generate_visualizations

```rust
fn generate_visualizations(&self, _results: &[BenchmarkResult]) -> ProcessingResult<()> {
```

Generate visualizations

#### print_summary

```rust
fn print_summary(&self, summary: &BenchmarkSummary) {
```

Print benchmark summary

#### csv_headers

```rust
fn csv_headers() -> Vec<String> {
```

CSV headers for serialization

#### execute_benchmark

```rust
pub fn execute_benchmark(args: &crate::cli::args::Commands) -> ProcessingResult<()> {
```

Execute benchmark command

---

*Source: [`benchmark.rs`](../../../cli/commands/benchmark.rs)*