Struct ConsensusParams 

pub struct ConsensusParams<F: BixverseFloat> {
    pub target: ConsensusTarget,
    pub n_neighbours: Option<usize>,
    pub density_threshold: Option<F>,
    pub kmeans_iters: usize,
    pub kmeans_n_init: usize,
    pub seed: u64,
}

Options for the consensus step.

Fields

target: ConsensusTarget

Which factor to cluster.

n_neighbours: Option<usize>

Neighbours used by the local-density filter. None or Some(0) resolve to LOCAL_NEIGHBOURHOOD_FRACTION * n_runs; both spellings mean “pick for me”, so that a zero arriving from R behaves the same way.

density_threshold: Option<F>

Mean cosine distance to those neighbours above which a component is dropped. None disables filtering entirely.

kmeans_iters: usize

Lloyd iterations per k-means restart.

kmeans_n_init: usize

Number of k-means restarts; the lowest-inertia labelling wins.

seed: u64

Seed for the k-means restarts.

Implementations

impl<F: BixverseFloat> ConsensusParams<F>

pub fn new( target: ConsensusTarget, n_neighbours: Option<usize>, density_threshold: Option<F>, kmeans_iters: usize, kmeans_n_init: usize, seed: u64, ) -> Self

Generate a new instance of ConsensusParams

Params

• target - Which factor to cluster, see ConsensusTarget.
• n_neighbours - Neighbours for the density filter. None or Some(0) for the 0.3 * n_runs heuristic.
• density_threshold - Mean cosine distance cutoff. None disables the filter.
• kmeans_iters - Lloyd iterations per k-means restart.
• kmeans_n_init - Number of k-means restarts.
• seed - Seed for the k-means restarts.

Returns

The initialised ConsensusParams.

Trait Implementations

impl<F: Clone + BixverseFloat> Clone for ConsensusParams<F>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Copy + BixverseFloat> Copy for ConsensusParams<F>

impl<F: Debug + BixverseFloat> Debug for ConsensusParams<F>

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

Formats the value using the given formatter.

impl<F: BixverseFloat> Default for ConsensusParams<F>

fn default() -> Self

Returns the “default value” for a type.