Struct MemoryBudget 

pub struct MemoryBudget(/* private fields */);

An upper bound on the memory used for buffering scores.

This governs how much scored output is held at once, which is the part of the footprint that scales with the genome. It does not cover the sequence of the record being read: without an index the FASTA reader hands over a whole record at a time, so the largest record’s sequence is a floor that a budget cannot lower.

Implementations

impl MemoryBudget

pub fn bytes(&self) -> u64

pub fn chunk_scores(&self, threads: usize, cap: usize) -> usize

How many scores one chunk should produce, given the number of worker threads.

Each thread holds one chunk’s scores while working, so the in-flight cost is threads * chunk_scores * 8 bytes. The result is capped at cap because past a point larger chunks only reduce parallelism, and floored so that a very small budget degrades rather than grinding to a halt.

impl MemoryBudget

pub fn window_bases(&self, cap: usize) -> usize

How many bases of sequence to hold at once when reading through an index.

The window is the sequence side of the footprint, so it gets a share of the budget separate from the score buffers, and is capped because past a point a larger window only costs memory without saving reads.

Trait Implementations

impl Clone for MemoryBudget

fn clone(&self) -> MemoryBudget

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MemoryBudget

impl Debug for MemoryBudget

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

Formats the value using the given formatter.

impl Display for MemoryBudget

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

Formats the value using the given formatter.

impl Eq for MemoryBudget

impl FromStr for MemoryBudget

fn from_str(s: &str) -> Result<Self, Self::Err>

Parse a size such as 8G, 512M, 64K or 1048576.

Suffixes are binary: 8G is 8 * 1024^3. KB/KiB spellings are accepted and mean the same thing, since offering both binary and decimal units under names that differ by one letter invites mistakes.

type Err = ParseBudgetError

The associated error which can be returned from parsing.

impl PartialEq for MemoryBudget

fn eq(&self, other: &MemoryBudget) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for MemoryBudget