Struct SoarConfig 

pub struct SoarConfig {
    pub num_secondary: usize,
    pub selective: bool,
    pub spill_threshold: f32,
}

Configuration for SOAR (Spilling with Orthogonality-Amplified Residuals)

Fields

num_secondary: usize

Number of secondary cluster assignments. Current trained generations use the published two-assignment objective, so builders clamp this to one secondary.

selective: bool

Use selective spilling (only spill vectors near cluster boundaries)

spill_threshold: f32

Positive values are calibrated residual-norm thresholds. A negative value requests build-time calibration to the corresponding spill fraction; trained artifacts always persist a positive threshold. This tagged representation preserves the serialized structure layout.

Implementations

impl SoarConfig

pub fn new() -> Self

Create SOAR config with 1 secondary assignment

pub fn with_secondary(num_secondary: usize) -> Self

Create SOAR config with specified number of secondary assignments

pub fn selective(self, enabled: bool) -> Self

Enable/disable selective spilling

pub fn threshold(self, threshold: f32) -> Self

Set spill threshold for selective spilling

pub fn target_spill_fraction(self, fraction: f32) -> Self

Calibrate selective spilling during training to at most a target fraction of vectors receiving one secondary assignment.

pub fn full() -> Self

Full spilling (no selectivity) - assigns all vectors to secondary clusters

pub fn aggressive() -> Self

Compatibility alias for full one-secondary spilling. The generalized multi-secondary objective is intentionally not exposed until it is implemented and validated.

Trait Implementations

impl Clone for SoarConfig

fn clone(&self) -> SoarConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SoarConfig

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

Formats the value using the given formatter.

impl Default for SoarConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SoarConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SoarConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.