Struct IlsResult

Source

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>>,
}

Expand description

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

Number of lattice points evaluated.

§covariance: Vec<Vec<f64>>

Symmetrized covariance actually used.

§covariance_inverse: Vec<Vec<f64>>

Symmetrized inverse covariance.

Trait Implementations§

Source §

impl Clone for IlsResult

Source §

fn clone(&self) -> IlsResult

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for IlsResult

Source §

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

Formats the value using the given formatter. Read more

Source §

impl PartialEq for IlsResult

Source §

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

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

1.0.0 (const: unstable) · Source§

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

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

Source §

impl StructuralPartialEq for IlsResult

Auto Trait Implementations§

§

impl UnwindSafe for IlsResult

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §