Skip to main content

ScalingPreview

Struct ScalingPreview 

Source
pub struct ScalingPreview {
    pub max_gradient: Number,
    pub max_grad_f: Number,
    pub obj_scale: Number,
    pub c: RowScaleBlock,
    pub d: RowScaleBlock,
    pub quad_rows: Vec<QuadRowScale>,
    pub n_quad_rows: usize,
    pub n_quad_unscaled: usize,
    pub n_quad_zero_jac: usize,
    pub max_quad_mismatch: Number,
}
Expand description

What nlp_scaling_method=gradient-based will do to this model at this x0 — the solver’s own arithmetic (gradient_obj_scale / gradient_row_scale), not a copy of it.

§Why a preflight reports this

Gradient-based scaling is a point sample: it reads ∇f and the Jacobian once, at x0, and never looks again. That is a good estimator of a row’s magnitude when the row’s derivative at x0 is representative of its derivative elsewhere, and no estimator at all when it is not. The extreme case is a row whose Jacobian vanishes at x0 — a ½xᵀQx ≤ b written about the origin, started from x = 0. The sample reads zero, the row is left at factor 1.0, and however badly Q and b disagree in magnitude the scaler has no way to know it. That is how AMPL emits qcqp1000-2c — every variable free, no initial guess, and k rows of pure ½xᵀQᵢx ≤ bᵢ.

So the two halves of this report are complementary: the block below says what the sample decided, and Self::quad_rows says what the sample could not see. See dev-notes/quadratic-structure-exploitation.md §8 (gh #703).

Fields§

§max_gradient: Number

The nlp_scaling_max_gradient cutoff this preview assumed.

§max_grad_f: Number

‖∇f(x0)‖_∞.

§obj_scale: Number

The objective factor df the scaler will pick.

§c: RowScaleBlock

Equality rows (g_l == g_u).

§d: RowScaleBlock

Everything else — the inequality and range rows.

§quad_rows: Vec<QuadRowScale>

Rows recognized as quadratic, worst mismatch first. .nl models only; empty for a builtin or a model with no quadratic row.

§n_quad_rows: usize

Total quadratic rows found (quad_rows is capped at --max-list).

§n_quad_unscaled: usize

Of those, how many the sample leaves at factor 1.0.

§n_quad_zero_jac: usize

Of those, how many have an identically-zero Jacobian row at x0.

§max_quad_mismatch: Number

Largest rhs / curvature over the quadratic rows, or 0 when there are none.

Trait Implementations§

Source§

impl Clone for ScalingPreview

Source§

fn clone(&self) -> ScalingPreview

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 ScalingPreview

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ScalingPreview

Source§

fn default() -> ScalingPreview

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Imply<T> for U
where T: ?Sized, U: ?Sized,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> 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§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more