Struct NlTnlp 

pub struct NlTnlp { /* private fields */ }

Implementations

impl NlTnlp

pub fn new(prob: NlProblem) -> NlTnlp

Build the TNLP, panicking if AMPL external-function resolution fails.

Kept for the many infallible call sites (CLI, tests) that operate on .nl models known to need no external libraries. Surfaces that can be handed an arbitrary user model — notably the Python read_nl binding — must call Self::try_new instead so a missing $AMPLFUNC library becomes a catchable error rather than an uncatchable panic across the pyo3 boundary.

pub fn try_new(prob: NlProblem) -> Result<NlTnlp, String>

Build the TNLP, returning an error (instead of panicking) when AMPL imported functions named by the model can’t be resolved — e.g. $AMPLFUNC is unset, a named library is missing/unloadable, or a referenced function id isn’t registered by any loaded library.

pub fn final_x(&self) -> Option<&[f64]>

pub fn final_obj(&self) -> f64

Trait Implementations

impl Debug for NlTnlp

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

Formats the value using the given formatter.

impl ExpressionProvider for NlTnlp

fn constraint_expression(&self, i: usize) -> Option<FbbtTape>

Per-.nl-row constraint expression tape, with the linear part folded in. Returns None for constraints that contribute neither a nonlinear expression nor any linear coefficients (so FBBT skips them — there’s nothing to tighten).

fn variable_name(&self, i: usize) -> Option<&str>

Variable name from the sibling .col file, if one was loaded. Index is original .nl column order.

fn constraint_name(&self, i: usize) -> Option<&str>

Constraint name from the sibling .row file, if one was loaded. Index is original .nl row order.

fn objective_expression(&self) -> Option<FbbtTape>

Expression tape for the objective. Optional in the same sense as Self::constraint_expression; FBBT does not use the objective today, but a future OBBT-style pass might.

impl TNLP for NlTnlp

fn get_var_con_metadata( &mut self, var: &mut MetaData, con: &mut MetaData, ) -> bool

Publish the .col / .row names (captured at load time) under the conventional idx_names metadata key, in original .nl order. The adapter permutes these into split space (see OrigIpoptNlp::split_space_names) so the debugger can report a near-singular Jacobian row as the mass_balance equation rather than “row 3” — the model-vs-index gap Lee et al. (2024, https://doi.org/10.69997/sct.147875) flag for equation-oriented model debugging. Declines (returns false) when the model shipped no name files so callers fall back to index labels.

fn get_nlp_info(&mut self) -> Option<NlpInfo>

Required. Problem dimensions and triplet index style.

fn get_bounds_info(&mut self, b: BoundsInfo<'_>) -> bool

Required. Variable / constraint bounds.

fn get_starting_point(&mut self, sp: StartingPoint<'_>) -> bool

Required. Initial primal (and optionally dual) point.

fn eval_f(&mut self, x: &[f64], _new_x: bool) -> Option<f64>

Required. Objective value at x.

fn eval_grad_f(&mut self, x: &[f64], _new_x: bool, grad: &mut [f64]) -> bool

Required. Objective gradient at x into grad_f.

fn eval_g(&mut self, x: &[f64], _new_x: bool, g: &mut [f64]) -> bool

Required. Constraint values g(x).

fn eval_jac_g( &mut self, x: Option<&[f64]>, _new_x: bool, mode: SparsityRequest<'_>, ) -> bool

Required. Jacobian of g. Sparsity vs. values selected by mode. x and new_x are unused on the structure call.

fn eval_h( &mut self, x: Option<&[f64]>, _new_x: bool, obj_factor: f64, lambda: Option<&[f64]>, _new_lambda: bool, mode: SparsityRequest<'_>, ) -> bool

Required for exact Hessian, optional for L-BFGS. Hessian of the Lagrangian. Default returns false (signals to %Ipopt that quasi-Newton must be used).

fn finalize_solution(&mut self, sol: Solution<'_>, _d: &IpoptData, _q: &IpoptCq)

Required. Receives the final iterate after solve.

fn get_constraints_linearity(&mut self, types: &mut [Linearity]) -> bool

Constraint linearity tags. Used by adaptive-mu’s nlp_scaling_method=equilibration-based.

fn get_scaling_parameters(&mut self, _req: ScalingRequest<'_>) -> bool

User-supplied scaling, used only when nlp_scaling_method=user-scaling. Default: declines.

fn get_variables_linearity(&mut self, _types: &mut [Linearity]) -> bool

Variable linearity tags (used by Bonmin, not by Ipopt).

fn get_number_of_nonlinear_variables(&mut self) -> i32

Number of variables that appear nonlinearly. Returning -1 means “treat all as nonlinear” (the Ipopt default).

fn get_list_of_nonlinear_variables( &mut self, _pos_nonlin_vars: &mut [i32], ) -> bool

List of nonlinear variable indices, in the index style returned from Self::get_nlp_info.

fn intermediate_callback( &mut self, _stats: IterStats, _ip_data: &IpoptData, _ip_cq: &IpoptCq, ) -> bool

Per-iteration intermediate callback. Returning false requests early termination with User_Requested_Stop.

fn finalize_metadata(&mut self, _var: &MetaData, _con: &MetaData)

Final metadata pass — called just before Self::finalize_solution. Default does nothing.