Skip to main content

ClassReason

Enum ClassReason 

Source
pub enum ClassReason {
Show 14 variants NoNonlinearParts, NonlinearPartsCancelled, ObjectiveNotQuadratic, ConstraintNotQuadratic { row: usize, }, ObjectiveTermsDropped, ConstraintTermsDropped { row: usize, }, ObjectiveHessianIndefinite, NonconvexQcqp { row: usize, }, ConstraintSenseNonconvex { row: usize, }, ConstraintHessianIndefinite { row: usize, }, QcqpReformTooCostly { flops: u128, }, QcqpTooLargeToSolve { size: u64, }, ConvexQuadraticObjective, ConvexQcqpWithinBudgets { flops: u128, size: u64, },
}
Expand description

Why classify_problem reached the class it did.

Every arm is a place the classifier stops — either because it proved a class or because it could not, and fell back to the more general one. The distinction matters most for a convex QCQP: four different findings (a nonconvex row, a nonconvex sense, an unaffordable reformulation, an oversized conic solve) all route to Nlp, and a user staring at Problem class: NLP on a model they know is a QCQP has so far had no way to tell which. POUNCE_DBG_CLASSIFY=1 prints it.

Variants§

§

NoNonlinearParts

Neither the objective nor any row carries a nonlinear part.

§

NonlinearPartsCancelled

Nonlinear parts exist but all of them expanded to nothing of degree 2 or higher — the model is linear after expansion.

§

ObjectiveNotQuadratic

The objective’s nonlinear part is not a degree-2 polynomial.

§

ConstraintNotQuadratic

Row row’s nonlinear part is not a degree-2 polynomial.

Fields

§row: usize
§

ObjectiveTermsDropped

The objective is degree ≤ 2, but the recognizer lost a term reaching its coefficients, so they are not the whole objective.

§

ConstraintTermsDropped

Row row is degree ≤ 2, but the recognizer lost a term reaching its coefficients, so they are not the whole row (gh #685).

“Lost”, not merely “dropped”: a term that cancels exactly is not missing from the form, so those rows keep the fast path (gh #687).

Fields

§row: usize
§

ObjectiveHessianIndefinite

The sense-adjusted objective Hessian has a negative eigenvalue, and every constraint row is linear — a nonconvex QP.

§

NonconvexQcqp

The sense-adjusted objective Hessian has a negative eigenvalue and some row carries curvature — a nonconvex QCQP, which is not a QP and must not be classified as one (see ProblemClass::NonconvexQp).

Fields

§row: usize
§

ConstraintSenseNonconvex

Row row is quadratic with a PSD Hessian, but its bound sense (>=, =, or two-sided) carves a nonconvex feasible set.

Fields

§row: usize
§

ConstraintHessianIndefinite

Row row’s quadratic Hessian is not PSD.

Fields

§row: usize
§

QcqpReformTooCostly

Convex QCQP, but the cone reformulation exceeds [SOCP_REFORM_FLOP_BUDGET].

Fields

§flops: u128
§

QcqpTooLargeToSolve

Convex QCQP whose reformulation is affordable, but whose conic solve exceeds [SOCP_SOLVE_SIZE_CAP].

Fields

§size: u64
§

ConvexQuadraticObjective

Convex quadratic objective, linear constraints.

§

ConvexQcqpWithinBudgets

Convex QCQP inside both guards — the conic path is taken.

Fields

§flops: u128
§size: u64

Implementations§

Source§

impl ClassReason

Source

pub fn explain(self) -> String

One-line explanation, for the POUNCE_DBG_CLASSIFY log.

Trait Implementations§

Source§

impl Clone for ClassReason

Source§

fn clone(&self) -> ClassReason

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 Copy for ClassReason

Source§

impl Debug for ClassReason

Source§

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

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

impl Eq for ClassReason

Source§

impl PartialEq for ClassReason

Source§

fn eq(&self, other: &ClassReason) -> 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 ClassReason

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> Boilerplate for T
where T: Copy + Send + Sync + Debug + PartialEq + 'static,

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