pub struct WriteToFile { /* private fields */ }
Expand description

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

Create a new instance of WriteToFile.

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

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

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.

Called at every iteration of the solver Read more

Called once after initialization of the solver. Read more

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

This method tests for !=.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

Checks if self is actually part of its subset T (and can be converted to it).

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

The inclusion map: converts self to the equivalent element of its superset.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.