Struct MustTrainFeatures 

pub struct MustTrainFeatures { /* private fields */ }

A force-include list of feature names loaded from --must-train-features: features that must enter the fit whether or not they make the HVG cut.

Implementations

impl MustTrainFeatures

pub fn load(file_path: &str) -> Result<Self>

Load the list from any of the supported formats. See the --must-train-features long_help for the accepted layouts.

pub fn load_union(file_paths: &[&str]) -> Result<Self>

Load the union of several name lists as one force-train set.

The motivating pair is an explicit --must-train-features list plus the --markers panel a downstream annotate will score on: those genes have to be on the trained axis for their calls to mean anything, and requiring the user to name the same file twice is exactly the kind of step that gets forgotten. Empty input is not an error — it just yields an empty set.

pub fn union(parts: &[&Self]) -> Self

Union of already-loaded lists, so a caller holding both an explicit force-train list and a marker panel can merge them without re-reading either file.

pub fn resolve(&self, vocab: &[Box<str>]) -> Vec<usize>

Resolve the list against a vocabulary (feature names, or the interned gene keys behind them) and return the matching indices, ascending and deduped.

Matching is lenient — see GeneIndex — so a CD8A panel resolves against an ENSG00000153563_CD8A vocabulary (and vice versa). A name that matches nothing is reported rather than fatal: marker panels routinely carry genes that a given assay never captured.

pub fn resolve_with(&self, index: &GeneIndex) -> Vec<usize>

Self::resolve against an already-built index. Building a GeneIndex lowercases and hash-indexes the whole gene vocabulary — tens of thousands of allocations — so a caller resolving two lists against the same vocabulary should build it once and call this twice, rather than paying for the index on each list.

pub fn resolve_quiet(&self, vocab: &[Box<str>]) -> Vec<usize>

Self::resolve without the match/miss summary, for a second resolution against the same vocabulary (the caller already reported it once, and re-reporting reads as a second, different list).

pub fn resolve_quiet_with(&self, index: &GeneIndex) -> Vec<usize>

Self::resolve_quiet against an already-built index — see Self::resolve_with.

Trait Implementations

impl Clone for MustTrainFeatures

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.