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

# Canonical

**Module**: `rustkmer::kmer::canonical`

## Overview

Canonical k-mer operations
Implements canonical k-mer representation (forward/reverse complement lexicographically smaller).

## API Reference

### Fns

#### canonical_kmer

```rust
pub fn canonical_kmer(kmer_encoded: u64, k: usize) -> ProcessingResult<u64> {
```

Get the canonical representation of a k-mer

The canonical k-mer is the lexicographically smaller of the forward k-mer
and its reverse complement.

# Arguments
* `kmer_encoded` - Packed k-mer representation
* `k` - K-mer length

# Returns
Canonical k-mer encoding

#### is_canonical

```rust
pub fn is_canonical(kmer_encoded: u64, k: usize) -> ProcessingResult<bool> {
```

Check if a k-mer is already in canonical form

# Arguments
* `kmer_encoded` - Packed k-mer representation
* `k` - K-mer length

# Returns
True if the k-mer is canonical, false otherwise

#### get_both_orientations

```rust
pub fn get_both_orientations(kmer_encoded: u64, k: usize) -> ProcessingResult<(String, String)> {
```

Get both forward and reverse complement sequences

# Arguments
* `kmer_encoded` - Packed k-mer representation
* `k` - K-mer length

# Returns
Tuple of (forward_sequence, reverse_complement_sequence)

---

*Source: [`canonical.rs`](../../../kmer/canonical.rs)*