Struct LineSearchOptions 

pub struct LineSearchOptions {

    pub watchdog_shortened_iter_trigger: Index,
    pub watchdog_trial_iter_max: Index,
    pub soft_resto_pderror_reduction_factor: Number,
    pub max_soft_resto_iters: Index,
    pub accept_every_trial_step: bool,
    pub alpha_for_y: AlphaForY,
    pub eta_phi: Number,
    pub theta_min_fact: Number,
    pub theta_max_fact: Number,
    pub theta_max_row_scale_kappa: Number,
    pub theta_max_adaptive_trigger: u32,
    pub theta_max_adaptive_factor: Number,
    pub theta_max_adaptive_max_raises: u32,
    pub gamma_phi: Number,
    pub gamma_theta: Number,
    pub s_phi: Number,
    pub s_theta: Number,
    pub alpha_min_frac: Number,
    pub obj_max_inc: Number,
    pub max_filter_resets: Index,
    pub filter_reset_trigger: Index,
    pub max_soc: Index,
    pub kappa_soc: Number,
    pub soc_method: Index,
}

Knobs baked into the assembled BacktrackingLineSearch. Defaults mirror IpBacktrackingLineSearch.cpp:RegisterOptions.

Fields

watchdog_shortened_iter_trigger: Index

watchdog_trial_iter_max: Index

soft_resto_pderror_reduction_factor: Number

soft_resto_pderror_reduction_factor — required relative reduction in the primal-dual error for a soft-resto step. 0 disables the soft restoration phase.

max_soft_resto_iters: Index

max_soft_resto_iters — cap on consecutive soft-resto iterations before full restoration is forced.

accept_every_trial_step: bool

accept_every_trial_step — short-circuits the filter / alpha loop and accepts the full fraction-to-the-boundary step every outer iteration. Mirrors upstream’s IpBacktrackingLineSearch::accept_every_trial_step_. Drops global convergence guarantees; only safe for problems where the Newton step is already a descent step (LPs, convex QPs). The Mehrotra cascade in application.rs flips this on.

alpha_for_y: AlphaForY

alpha_for_y — policy for the equality-multiplier (y_c / y_d) step length. Upstream default is Primal; the Mehrotra cascade switches to BoundMult.

eta_phi: Number

eta_phi — relaxation factor in the Armijo condition (Eqn. (20)).

theta_min_fact: Number

theta_min_fact — constraint-violation threshold factor in the switching rule.

theta_max_fact: Number

theta_max_fact — upper-bound factor for constraint violation in the filter (Eqn. (21)).

theta_max_row_scale_kappa: Number

theta_max_row_scale_kappa — multiplier on the constraint-row count used as the floor of the theta_max reference. Opt-in: default 0, which is upstream’s bare max(1, theta_0) floor bit-for-bit. Set to 1 on a large model that stalls from a feasible start. See FilterLsAcceptor::theta_max_row_scale_kappa.

theta_max_adaptive_trigger: u32

theta_max_adaptive_trigger — consecutive line searches whose every trial was refused at the theta_max gate before the ceiling is raised. 0 disables the rule. See FilterLsAcceptor::theta_max_adaptive_trigger (pounce#546).

theta_max_adaptive_factor: Number

Geometric factor applied to theta_max on each adaptive raise. See FilterLsAcceptor::theta_max_adaptive_factor.

theta_max_adaptive_max_raises: u32

Cap on adaptive raises per solve, which is what keeps theta_max finite. See FilterLsAcceptor::theta_max_adaptive_max_raises.

gamma_phi: Number

gamma_phi — filter margin factor for the barrier function (Eqn. (18a)).

gamma_theta: Number

gamma_theta — filter margin factor for the constraint violation (Eqn. (18b)).

s_phi: Number

s_phi — exponent for the linear barrier model in the switching rule (Eqn. (19)).

s_theta: Number

s_theta — exponent for the current constraint violation in the switching rule (Eqn. (19)).

alpha_min_frac: Number

alpha_min_frac — safety factor for the minimal step size before switching to restoration (gamma_alpha, Eqn. (23)).

obj_max_inc: Number

obj_max_inc — max acceptable increase (orders of magnitude) of the barrier objective for a trial point.

max_filter_resets: Index

max_filter_resets — maximum number of filter resets allowed (0 disables the reset heuristic).

filter_reset_trigger: Index

filter_reset_trigger — successive filter-rejected iterations that trigger a filter reset.

max_soc: Index

max_soc — max second-order-correction trial steps per iteration; 0 disables SOC.

kappa_soc: Number

kappa_soc — sufficient-reduction factor for a SOC step to be continued.

soc_method: Index

soc_method — 0 (paper method) or 1 (alpha-on-rhs variant).

Trait Implementations

impl Clone for LineSearchOptions

fn clone(&self) -> LineSearchOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LineSearchOptions

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

Formats the value using the given formatter.

impl Default for LineSearchOptions

fn default() -> Self

Returns the “default value” for a type.