Skip to main content

PluginEventHandler

Trait PluginEventHandler 

Source
pub trait PluginEventHandler: Send + Sync {
    // Provided methods
    fn on_step(
        &mut self,
        _step: usize,
        _params: &Array1<f64>,
        _gradients: &Array1<f64>,
    ) { ... }
    fn on_convergence(&mut self, _finalparams: &Array1<f64>) { ... }
    fn on_error(&mut self, _error: &OptimError) { ... }
    fn on_custom_event(&mut self, _event_name: &str, _data: &dyn Any) { ... }
}
Expand description

Plugin event system

Send + Sync because an event handler is stored inside Box<dyn PluginEventHandler> on BaseOptimizerPlugin, and OptimizerPlugin<A>: Debug + Send + Sync requires every field of any implementor to satisfy the same bound.

Provided Methods§

Source

fn on_step( &mut self, _step: usize, _params: &Array1<f64>, _gradients: &Array1<f64>, )

Handle optimization step event

Source

fn on_convergence(&mut self, _finalparams: &Array1<f64>)

Handle convergence event

Source

fn on_error(&mut self, _error: &OptimError)

Handle error event

Source

fn on_custom_event(&mut self, _event_name: &str, _data: &dyn Any)

Handle custom event

Dyn Compatibility§

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§