Struct lt_fm_index::LtFmIndexConfig

pub struct LtFmIndexConfig { /* fields omitted */ }

Configuration to generate LtFmIndex safely.

LtFmIndexConfig can safely generate all implementation types in the crate::use_case module through limitations of setting values.

• Default Setting
  • Text with no noise (NucleotideOnly, AminoacidOnly)
  • Default kmer size
    • NucleotideOnly: 10
    • NucleotideWithNoise: 9
    • AminoacidOnly: 5
    • AminoacidWithNoise: 5
  • Sampling ratio is 2
  • Bwt interval is 64

Implementations

impl LtFmIndexConfig

pub fn for_nucleotide() -> Self

New Config for nucleotide

pub fn for_aminoacid() -> Self

New Config for aminoacid

pub fn with_noise(self) -> Self

Text contains noise

pub fn change_kmer_size(self, kmer_size: usize) -> Result<Self>

Change kmer size for kmer count table

Kmer size allows the value not less than the length of the text and half the pointer width.

pub fn change_sampling_ratio(self, sa_sampling_ratio: u64) -> Result<Self>

Change sampling ratio for suffix array

Sampling ratio allows the positive integer

pub fn change_bwt_interval_to_128(self) -> Self

Change bwt interval to 128 (default is 64)

pub fn generate(self, text: Text) -> Result<LtFmIndexAll>

Generate LtFmIndex with Text

Trait Implementations

impl Debug for LtFmIndexConfig

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

Formats the value using the given formatter.