Struct argmin::prelude::Observer

pub struct Observer<O> { /* fields omitted */ }

Container for observers which acts just like a single Observer by implementing Observe on it.

Methods

impl<O> Observer<O> where
    O: ArgminOp, 

pub fn new() -> Observer<O>

Constructor

pub fn push<OBS>(
    &mut self,
    observer: OBS,
    mode: ObserverMode
) -> &mut Observer<O> where
    OBS: 'static + Observe<O>, 

Push another Observe to the observer field

Trait Implementations

impl<O> Clone for Observer<O> where
    O: Clone, 

fn clone(&self) -> Observer<O>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<O> Default for Observer<O> where
    O: Default, 

fn default() -> Observer<O>

Returns the "default value" for a type.

impl<O> Observe<O> for Observer<O> where
    O: ArgminOp, 

By implementing Observe for Observer we basically allow a set of Observers to be used just like a single Observer.

fn observe_init(&self, msg: &str, kv: &ArgminKV) -> Result<(), Error>

Initial observation This is called after the initialization in an Executor and gets the name of the solver as string and a ArgminKV which includes some solver-specific information.

fn observe_iter(&self, state: &IterState<O>, kv: &ArgminKV) -> Result<(), Error>

This is called after every iteration and gets the current state of the solver as well as a KV which can include solver-specific information This respects the ObserverMode: Every Observer is only called as often as specified.