Struct argmin::core::Observer

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

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

Implementations

impl<O: ArgminOp> Observer<O>

pub fn new() -> Self

Constructor

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

Push another Observe to the observer field

pub fn is_empty(&self) -> bool

Returns true if observers is empty

Trait Implementations

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

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> Default for Observer<O>

fn default() -> Observer<O>

Returns the “default value” for a type.

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

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(
    &mut 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.