Enum PirlsStatus 

pub enum PirlsStatus {
    Converged,
    StalledAtValidMinimum,
    MaxIterationsReached,
    LmStepSearchExhausted,
    Unstable,
}

The status of the P-IRLS convergence.

Variants

Converged

Converged successfully within tolerance.

StalledAtValidMinimum

Reached maximum iterations but the gradient and Hessian indicate a valid minimum.

MaxIterationsReached

Reached maximum iterations without converging.

LmStepSearchExhausted

Levenberg-Marquardt step search exhausted its retry budget (damping λ reached its ceiling, attempts counter expired, or λ went non-finite) before the projected gradient entered the near-stationary band. Distinct from MaxIterationsReached, which means the outer iteration counter itself ran out — that exhaustion is a “looped 100×, made progress each time but never converged” signal, while this one is a “no acceptable step direction even after damping” signal pointing at curvature trouble or saturated likelihoods.

Unstable

Fitting process became unstable, likely due to perfect separation.

Implementations

impl PirlsStatus

pub const fn is_failed_max_iterations(self) -> bool

Whether the inner loop concluded without producing a usable mode. Both the iteration-cap and LM-exhausted exits should be treated the same by callers that just want to know “did we get a valid solution?”.

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

Short human-readable label for reports and diagnostics. Stable text (not the Debug rendering) so report output does not silently change if the variant identifiers are ever renamed.

pub const fn is_converged(self) -> bool

Whether this status represents a clean convergence to the mode. Only Converged qualifies; every other state carries a caveat a reader should see flagged.

Trait Implementations

impl Clone for PirlsStatus

fn clone(&self) -> PirlsStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PirlsStatus

impl Debug for PirlsStatus

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PirlsStatus

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for PirlsStatus

impl PartialEq for PirlsStatus

fn eq(&self, other: &PirlsStatus) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PirlsStatus

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PirlsStatus