Struct argmin::core::observers::Observers

pub struct Observers<I> { /* private fields */ }

Container for observers.

This tpe also implements Observe and therefore can be used like a single observer. Each observer has an ObserverMode attached which indicates when the observer will be called.

Implementations

impl<I> Observers<I>

pub fn new() -> Self

Construct a new empty Observers instance.

Example

use argmin::core::observers::Observers;
use argmin::core::IterState;

let observers: Observers<IterState<Vec<f64>, (), (), (), f64>> = Observers::new();

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

Add another observer with a corresponding ObserverMode.

Example

use argmin::core::observers::{Observers, ObserverMode};
use argmin::core::observers::SlogLogger;
use argmin::core::IterState;

let mut observers: Observers<IterState<Vec<f64>, (), (), (), f64>> = Observers::new();

let logger = SlogLogger::term();
observers.push(logger, ObserverMode::Always);

pub fn is_empty(&self) -> bool

Returns true if there are no observers stored.

Example

use argmin::core::observers::Observers;
use argmin::core::IterState;

let observers: Observers<IterState<Vec<f64>, (), (), (), f64>> = Observers::new();
assert!(observers.is_empty());

Trait Implementations

impl<I: Clone> Clone for Observers<I>

fn clone(&self) -> Observers<I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I: Default> Default for Observers<I>

fn default() -> Observers<I>

Returns the “default value” for a type.

impl<I: State> Observe<I> for Observers<I>

Implementing Observe for Observers allows to use it like a single observer. In its implementation it will loop over all stored observers, checks if the conditions for observing are met and calls the actual observers if required.

fn observe_init(&mut self, name: &str, kv: &KV) -> Result<(), Error>

After initialization of the solver, this loops over all stored observers and calls them.

fn observe_iter(&mut self, state: &I, kv: &KV) -> Result<(), Error>

Called after each iteration.

Loops over all observers, and based on whether the condition for calling the observers are met, calls them.