Struct TofMultiBankInstrumentOptions

Source

pub struct TofMultiBankInstrumentOptions {
    pub lebail: TofLeBailOptions,
    pub instrument_damping: f64,
    pub max_scaled_instrument_step: f64,
    pub max_instrument_backtracks: usize,
    pub unresolved_correlation: f64,
}

Expand description

Controls for alternating local Le Bail updates and one instrument step.

Fields§

§lebail: TofLeBailOptions

Existing TOF redistribution, support, weighting, and execution controls.

§instrument_damping: f64

Non-negative diagonal regularization in scaled instrument coordinates.

§max_scaled_instrument_step: f64

Maximum absolute coefficient step in scaled coordinates.

§max_instrument_backtracks: usize

Number of objective backtracking halvings after the initial trial.

§unresolved_correlation: f64

Absolute weighted-column correlation reported as unresolved.

Implementations§

Source §

impl TofMultiBankInstrumentOptions

Source

pub fn new( lebail: TofLeBailOptions, instrument_damping: f64, max_scaled_instrument_step: f64, max_instrument_backtracks: usize, unresolved_correlation: f64, ) -> Result<Self, TofMultiBankInstrumentError>

Construct validated bank-local instrument controls.

§Errors

Returns TofMultiBankInstrumentError::InvalidOptions for invalid controls.

Source

pub fn validate(&self) -> Result<(), TofMultiBankInstrumentError>

Revalidate numerical controls.

§Errors

Returns TofMultiBankInstrumentError::InvalidOptions for invalid fields.

Trait Implementations§

Source §

impl Clone for TofMultiBankInstrumentOptions

Source §

fn clone(&self) -> TofMultiBankInstrumentOptions

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 TofMultiBankInstrumentOptions

Source §

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

Formats the value using the given formatter. Read more

Source §

impl PartialEq for TofMultiBankInstrumentOptions

Source §

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

Source §

impl StructuralPartialEq for TofMultiBankInstrumentOptions

Auto Trait Implementations§

§

impl UnsafeUnpin for TofMultiBankInstrumentOptions

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 §