Struct argmin::core::observers::file::WriteToFile

pub struct WriteToFile { /* private fields */ }

Write parameter vectors to a file during optimization.

This observer requires a directory to save the files to and a file prefix. Files will be written to disk as <directory>/<file_prefix>_<iteration_number>.arp. For serialization either JSON or bincode can be chosen via the enum WriteToFileSerializer.

This feature requires the serde1 feature to be set.

Example

Create an observer for saving the parameter vector into a JSON file.

use argmin::core::observers::{WriteToFile, WriteToFileSerializer};

let observer = WriteToFile::new("directory", "file_prefix", WriteToFileSerializer::JSON);

Create an observer for saving the parameter vector into a binary file using bincode.

use argmin::core::observers::{WriteToFile, WriteToFileSerializer};

let observer = WriteToFile::new("directory", "file_prefix", WriteToFileSerializer::Bincode);

Implementations

impl WriteToFile

pub fn new<N: AsRef<str>>(
    dir: N,
    prefix: N,
    serializer: WriteToFileSerializer
) -> Self

Create a new instance of WriteToFile.

Example

let observer = WriteToFile::new("directory", "file_prefix", WriteToFileSerializer::JSON);

Trait Implementations

impl Clone for WriteToFile

fn clone(&self) -> WriteToFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WriteToFile

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<I> Observe<I> for WriteToFile where
    I: State,
    <I as State>::Param: Serialize, 

WriteToFile only implements observer_iter and not observe_init to avoid saving the initial parameter vector. It will only save if there is a parameter vector available in the state, otherwise it will skip saving silently.

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

Called at every iteration of the solver

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

Called once after initialization of the solver.

impl PartialEq<WriteToFile> for WriteToFile

fn eq(&self, other: &WriteToFile) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for WriteToFile

impl StructuralEq for WriteToFile

impl StructuralPartialEq for WriteToFile