Struct BuildConfiguration 

pub struct BuildConfiguration {
    pub k: usize,
    pub m: usize,
    pub seed: u64,
    pub num_threads: usize,
    pub ram_limit_gib: usize,
    pub lambda: f64,
    pub canonical: bool,
    pub partitioned_mphf: bool,
    pub weighted: bool,
    pub verbose: bool,
    pub tmp_dirname: PathBuf,
}

Configuration parameters for building an SSHash dictionary

Fields

k: usize

K-mer length (must be odd, between 3 and 63)

m: usize

Minimizer length (must be odd, m < k)

seed: u64

Seed for hash functions

num_threads: usize

Number of threads for parallel operations (0 = all available cores)

ram_limit_gib: usize

RAM limit in GiB for external sorting

lambda: f64

PTHash lambda parameter (trade-off for MPHF construction) Typically 3.5-4.0 for minimal size, higher for faster queries

canonical: bool

Build in canonical mode (k-mer and reverse-complement map to same entry)

partitioned_mphf: bool

Use partitioned MPHF for parallel construction (default: true)

weighted: bool

Build weighted dictionary (with k-mer abundance/weights)

verbose: bool

Verbose output during construction

tmp_dirname: PathBuf

Directory for temporary files during construction

Implementations

impl BuildConfiguration

pub fn new(k: usize, m: usize) -> Result<Self, String>

Create a new build configuration with the specified k-mer and minimizer lengths

pub fn validate(&self) -> Result<(), String>

Validate the configuration parameters

pub fn print(&self)

Log configuration parameters via tracing

Trait Implementations

impl Clone for BuildConfiguration

fn clone(&self) -> BuildConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BuildConfiguration

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

Formats the value using the given formatter.

impl Default for BuildConfiguration

fn default() -> Self

Returns the “default value” for a type.