argmin::coreTrait Observe
Source pub trait Observe<O: ArgminOp> {
// Provided methods
fn observe_init(&self, _name: &str, _kv: &ArgminKV) -> Result<(), Error> { ... }
fn observe_iter(
&mut self,
_state: &IterState<O>,
_kv: &ArgminKV,
) -> Result<(), Error> { ... }
}
Expand description
Defines the interface every Observer needs to expose
Called once at the beginning of the execution of the solver.
Parameters:
name
: Name of the solver
kv
: Key-Value storage of initial configurations defined by the Solver
Called at every iteration of the solver
Parameters
state
: Current state of the solver. See documentation of IterState
for details.
kv
: Key-Value store of relevant variables defined by the Solver
By implementing Observe
for Observer
we basically allow a set of Observer
s to be used
just like a single Observe
r.