Struct Bwt 

pub struct Bwt { /* private fields */ }

Burrows-Wheeler Transform of a byte string.

Constructed by appending a sentinel $ to the input, building the suffix array, and reading off the last column of the sorted rotation matrix.

Implementations

impl Bwt

pub fn build(text: &[u8]) -> Self

Build the BWT of text.

A sentinel $ (0x00) is appended internally and is lexicographically smaller than every input byte.

Example

use cyanea_seq::bwt::Bwt;

let bwt = Bwt::build(b"banana");
assert_eq!(bwt.len(), 7); // 6 + sentinel

pub fn as_bytes(&self) -> &[u8]

The BWT string as a byte slice.

pub fn primary_index(&self) -> usize

Position of the sentinel character ($) in the BWT.

pub fn len(&self) -> usize

Length of the BWT (including sentinel).

pub fn is_empty(&self) -> bool

Whether the BWT is empty (only possible for empty input + sentinel).

pub fn invert(&self) -> Vec<u8>

Reconstruct the original text (without sentinel) from the BWT.

Uses the LF-mapping: build C table (cumulative counts of characters smaller than c) and occurrence counts, then walk from the row containing the sentinel to reconstruct the text in reverse.

Example

use cyanea_seq::bwt::Bwt;

let text = b"banana";
let bwt = Bwt::build(text);
let recovered = bwt.invert();
assert_eq!(recovered, text);

Trait Implementations

impl Clone for Bwt

fn clone(&self) -> Bwt

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Bwt

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.