Skip to main content

TrustRegionDecision

Enum TrustRegionDecision 

Source
pub enum TrustRegionDecision {
    GrowAtBoundary,
    HoldInside,
    HoldModerate,
    ShrinkOnMarginalAccept,
    ShrinkOnRejection,
    RejectFloor,
}
Expand description

Rich classification of the branch a TrustRegionPolicy::update took on a single trust-region step. Surfaced so callers can log at a glance whether the solver is being throttled by the region (ShrinkOnRejection / RejectFloor), sitting well inside it (HoldInside), or expanding into freshly available room (GrowAtBoundary).

The four Accepted-family variants (GrowAtBoundary, HoldInside, HoldModerate, ShrinkOnMarginalAccept) all correspond to accepted steps; the remaining two to rejected ones. Two orthogonal signals — whether the realized reduction was within the objective’s round-off noise floor, and whether the model’s predicted reduction was non-positive — are reported as booleans on TrustRegionStep rather than stealing a decision label, so the classification above stays a faithful superset of every consumer’s existing telemetry.

Variants§

§

GrowAtBoundary

rho > eta_expand AND the step reached the region boundary — the model is excellent and the radius was the binding constraint, so the radius was expanded.

§

HoldInside

rho > eta_expand but the step sits inside the region; radius held (no evidence the region constrained the step).

§

HoldModerate

eta_shrink <= rho <= eta_expand (moderate fidelity) — radius held.

§

ShrinkOnMarginalAccept

Step accepted (rho > eta_accept) but rho < eta_shrink; radius shrunk to be more conservative next iteration.

§

ShrinkOnRejection

Step rejected — radius shrunk (and, when a rejection step cap is configured, additionally capped to a fraction of the proposed step norm so a re-proposal stays inside the rejected region).

§

RejectFloor

A shrink landed the radius at (or below) min_radius. Persistent RejectFloor is the unambiguous signal that no descent direction exists at the smallest admissible radius.

Implementations§

Source§

impl TrustRegionDecision

Source

pub fn label(self) -> &'static str

Stable, lower-snake-case label for structured logs.

Source

pub fn is_accepted(self) -> bool

true for the decisions that correspond to an accepted step.

Trait Implementations§

Source§

impl Clone for TrustRegionDecision

Source§

fn clone(&self) -> TrustRegionDecision

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 TrustRegionDecision

Source§

impl Debug for TrustRegionDecision

Source§

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

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

impl Eq for TrustRegionDecision

Source§

impl PartialEq for TrustRegionDecision

Source§

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

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

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

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, 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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