Skip to main content

EarlyStopHandler

Struct EarlyStopHandler 

Source
pub struct EarlyStopHandler {
    pub threshold: F,
    pub warmup: usize,
    pub patience: usize,
    /* private fields */
}
Expand description

Requests early termination when improvement stalls.

Tracks fdist + frest total violation. After warmup iterations, if the relative improvement drops below threshold for patience consecutive steps, sets the stop flag.

Added as a default handler by crate::packer::Molpack::new.

Fields§

§threshold: F

Relative improvement threshold.

§warmup: usize

Iterations to skip before tracking. Default: 5.

§patience: usize

Consecutive stall iterations before stopping. Default: 3.

Implementations§

Source§

impl EarlyStopHandler

Source

pub fn new(threshold: F) -> Self

Source

pub fn with_warmup(self, warmup: usize) -> Self

Source

pub fn with_patience(self, patience: usize) -> Self

Trait Implementations§

Source§

impl Default for EarlyStopHandler

Source§

fn default() -> Self

Default is intentionally conservative (effectively disabled), so Packmol-sized examples are not stopped before convergence.

Source§

impl Handler for EarlyStopHandler

Source§

fn on_initialized(&mut self, _sys: &PackContext)

Called once after initialization completes, with valid xcart positions. Use this to write the initial conformation (e.g. XYZHandler).
Source§

fn on_phase_start(&mut self, _info: &PhaseInfo)

Called at the start of each packing phase (per-type and all-types). Allows stateful handlers to reset between phases.
Source§

fn on_step(&mut self, info: &StepInfo, _sys: &PackContext)

Called after each outer optimization loop iteration.
Source§

fn should_stop(&self) -> bool

Return true to request early termination of the packing loop.
Source§

fn on_start(&mut self, _ntotat: usize, _ntotmol: usize)

Called immediately at the start of pack, before any computation. Use this for immediate user feedback.
Source§

fn on_finish(&mut self, _sys: &PackContext)

Called once after the packing loop finishes (convergence or max loops).
Source§

fn on_inner_iter(&mut self, _iter: u32, _f: F, _sys: &PackContext)

Called after each inner GENCAN iteration (more granular than on_step). Read more
Source§

fn on_phase_end(&mut self, _info: &PhaseInfo, _report: &PhaseReport)

Called at the end of each packing phase, with a summary report. 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<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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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