Struct IlsResult 

pub struct IlsResult {
    pub fixed: Vec<i64>,
    pub fixed_status: bool,
    pub ratio: f64,
    pub best_score: f64,
    pub second_best_score: Option<f64>,
    pub candidates_evaluated: usize,
    pub covariance: Vec<Vec<f64>>,
    pub covariance_inverse: Vec<Vec<f64>>,
}

Outcome of a bounded ILS search.

Fields

fixed: Vec<i64>

Best integer vector, parallel to the input float_cycles.

fixed_status: bool

Whether the ratio test passes at the requested threshold.

ratio: f64

Runner-up / best score ratio. Saturates to f64::MAX when the best score is exactly zero with a positive runner-up; 0.0 when there is no runner-up.

best_score: f64

Best (lowest) quadratic score Δᵀ Q⁻¹ Δ.

second_best_score: Option<f64>

Runner-up score, if a second lattice point exists.

candidates_evaluated: usize

Count of candidates considered. Its meaning depends on the search: bounded_ils_search reports the number of lattice points actually evaluated inside the box; the LAMBDA search (lambda_ils_search) does not enumerate a box, so it reports the number of candidate vectors produced (the requested ncands, typically 2), not a lattice-point count.

covariance: Vec<Vec<f64>>

Symmetrized covariance actually used.

covariance_inverse: Vec<Vec<f64>>

Symmetrized inverse covariance.

Trait Implementations

impl Clone for IlsResult

fn clone(&self) -> IlsResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IlsResult

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

Formats the value using the given formatter.

impl PartialEq for IlsResult

fn eq(&self, other: &IlsResult) -> 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 IlsResult